Coverage Report - org.simpleframework.xml.util.Match
 
Classes in this File Line Coverage Branch Coverage Complexity
Match
N/A
N/A
1
 
 1  
 /*
 2  
  * Match.java March 2002
 3  
  *
 4  
  * Copyright (C) 2001, Niall Gallagher <niallg@users.sf.net>
 5  
  *
 6  
  * Licensed under the Apache License, Version 2.0 (the "License");
 7  
  * you may not use this file except in compliance with the License.
 8  
  * You may obtain a copy of the License at
 9  
  *
 10  
  *     http://www.apache.org/licenses/LICENSE-2.0
 11  
  *
 12  
  * Unless required by applicable law or agreed to in writing, software
 13  
  * distributed under the License is distributed on an "AS IS" BASIS,
 14  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
 15  
  * implied. See the License for the specific language governing 
 16  
  * permissions and limitations under the License.
 17  
  */
 18  
  
 19  
 package org.simpleframework.xml.util;
 20  
 
 21  
 /**
 22  
  * This object is stored within a <code>Resolver</code> so that it 
 23  
  * can be retrieved using a string that matches its pattern. Any
 24  
  * object that extends this can be inserted into the resolver and
 25  
  * retrieved using a string that matches its pattern. For example
 26  
  * take the following pattern "*.html" this will match the string
 27  
  * "/index.html" or "readme.html". This object should be extended
 28  
  * to add more XML attributes and elements, which can be retrieved
 29  
  * when the <code>Match</code> object is retrieve from a resolver.
 30  
  *
 31  
  * @author Niall Gallagher
 32  
  */
 33  
 public interface Match {
 34  
 
 35  
    /**
 36  
     * This is the pattern string that is used by the resolver. A
 37  
     * pattern can consist of a "*" character and a "?" character
 38  
     * to match the pattern. Implementations of this class should
 39  
     * provide the pattern so that it can be used for resolution.
 40  
     * 
 41  
     * @return this returns the pattern that is to be matched
 42  
     */      
 43  
    String getPattern();
 44  
 }