001    /*
002     * Created on Jun 25, 2009
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 @2009-2010 the original author or authors.
015     */
016    package org.fest.swing.util;
017    
018    /**
019     * Understands matching a given text to one or more values.
020     *
021     * @author Alex Ruiz
022     */
023    public interface TextMatcher {
024    
025      /**
026       * Indicates whether the given text matches some value(s).
027       * @param text the text to verify.
028       * @return <code>true</code> if the given text matches some value(s), <code>false</code> otherwise.
029       */
030      boolean isMatching(String text);
031    
032      /**
033       * Returns the description of the type of value this matcher supports.
034       * @return the description of the type of value this matcher supports.
035       */
036      String description();
037    
038      /**
039       * Returns the values in this matcher, formatted as a <code>String</code>.
040       * @return the values in this matcher, formatted as a <code>String</code>.
041       */
042      String formattedValues();
043    }