StyleAssociation.java

/*
 * Copyright 2003-2004 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */
package sun.swing.plaf.synth;

import javax.swing.plaf.synth.*;
import java.util.*;
import java.util.regex.*;

/**
 * <b>WARNING:</b> This class is an implementation detail and is only
 * public so that it can be used by two packages. You should NOT consider
 * this public API.
 * <p>
 * StyleAssociation is used to lookup a style for a particular
 * component (or region).
 *
 * @author Scott Violet
 */
public class StyleAssociation {
    /**
     * The style
     */
    private SynthStyle _style;

    /**
     * Pattern used for matching.
     */
    private Pattern _pattern;
    /**
     * Matcher used for testing if path matches that of pattern.
     */
    private Matcher _matcher;

    /**
     * Identifier for this association.
     */
    private int _id;


    /**
     * Returns a StyleAssociation that can be used to determine if
     * a particular string matches the returned association.
     */
    public static StyleAssociation createStyleAssociation(
        String text, SynthStyle style)
        throws PatternSyntaxException {
        return createStyleAssociation(text, style, 0);
    }

    /**
     * Returns a StyleAssociation that can be used to determine if
     * a particular string matches the returned association.
     */
    public static StyleAssociation createStyleAssociation(
        String text, SynthStyle style, int id)
        throws PatternSyntaxException {
        return new StyleAssociation(text, style, id);
    }


    private StyleAssociation(String text, SynthStyle style, int id)
                 throws PatternSyntaxException {
        _style = style;
        _pattern = Pattern.compile(text);
        _id = id;
    }

    /**
     * Returns the developer specified identifier for this association, will
     * be <code>0</code> if an identifier was not specified when this
     * <code>StyleAssociation</code> was created.
     */
    public int getID() {
        return _id;
    }

    /**
     * Returns true if this <code>StyleAssociation</code> matches the
     * passed in CharSequence.
     *
     * @return true if this <code>StyleAssociation</code> matches the
     * passed in CharSequence.if this StyleAssociation.
     */
    public synchronized boolean matches(CharSequence path) {
        if (_matcher == null) {
            _matcher = _pattern.matcher(path);
        }
        else {
            _matcher.reset(path);
        }
        return _matcher.matches();
    }

    /**
     * Returns the text used in matching the string.
     *
     * @return the text used in matching the string.
     */
    public String getText() {
        return _pattern.pattern();
    }

    /**
     * Returns the style this association is mapped to.
     *
     * @return the style this association is mapped to.
     */
    public SynthStyle getStyle() {
        return _style;
    }
}