org.simpleframework.xml.util.Match Maven / Gradle / Ivy
/*
* Match.java March 2002
*
* Copyright (C) 2001, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml.util;
/**
* This object is stored within a Resolver
so that it
* can be retrieved using a string that matches its pattern. Any
* object that extends this can be inserted into the resolver and
* retrieved using a string that matches its pattern. For example
* take the following pattern "*.html" this will match the string
* "/index.html" or "readme.html". This object should be extended
* to add more XML attributes and elements, which can be retrieved
* when the Match
object is retrieve from a resolver.
*
* @author Niall Gallagher
*/
public interface Match {
/**
* This is the pattern string that is used by the resolver. A
* pattern can consist of a "*" character and a "?" character
* to match the pattern. Implementations of this class should
* provide the pattern so that it can be used for resolution.
*
* @return this returns the pattern that is to be matched
*/
public String getPattern();
}