001    /*
002     * Created on Apr 14, 2008
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005     * in compliance with the License. You may obtain a copy of the License at
006     *
007     * http://www.apache.org/licenses/LICENSE-2.0
008     *
009     * Unless required by applicable law or agreed to in writing, software distributed under the License
010     * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011     * or implied. See the License for the specific language governing permissions and limitations under
012     * the License.
013     *
014     * Copyright @2008-2010 the original author or authors.
015     */
016    package org.fest.swing.cell;
017    
018    import javax.swing.JTree;
019    
020    import org.fest.swing.annotation.RunsInCurrentThread;
021    
022    /**
023     * Understands reading the internal value of a cell in a <code>{@link JTree}</code> as expected in a test.
024     * <p>
025     * <b>Note:</b> methods in this interface are <b>not</b> guaranteed to be executed in the event dispatch thread (EDT.)
026     * Clients are responsible for invoking them in the EDT.
027     * </p>
028     *
029     * @author Yvonne Wang
030     * @author Alex Ruiz
031     */
032    @RunsInCurrentThread
033    public interface JTreeCellReader {
034    
035      /**
036       * Returns the internal value of a cell in a <code>{@link JTree}</code> as expected in a test.
037       * <p>
038       * <b>Note:</b> Implementations of this method <b>may not</b> guaranteed to be executed in the event dispatch thread
039       * (EDT.) Clients are responsible for invoking this method in the EDT.
040       * </p>
041       * @param tree the given <code>JTree</code>.
042       * @param modelValue the value of a cell, retrieved from the model.
043       * @return the internal value of a cell in a <code>JTree</code> as expected in a test.
044       */
045      String valueAt(JTree tree, Object modelValue);
046    }