Coverage Report - com.mattunderscore.filter.contentnegotiation.variantsource.VariantSource
 
Classes in this File Line Coverage Branch Coverage Complexity
VariantSource
N/A
N/A
1
 
 1  
 /* Copyright © 2013 Matthew Champion
 2  
 All rights reserved.
 3  
 
 4  
 Redistribution and use in source and binary forms, with or without
 5  
 modification, are permitted provided that the following conditions are met:
 6  
  * Redistributions of source code must retain the above copyright
 7  
       notice, this list of conditions and the following disclaimer.
 8  
  * Redistributions in binary form must reproduce the above copyright
 9  
       notice, this list of conditions and the following disclaimer in the
 10  
       documentation and/or other materials provided with the distribution.
 11  
  * Neither the name of mattunderscore.com nor the
 12  
       names of its contributors may be used to endorse or promote products
 13  
       derived from this software without specific prior written permission.
 14  
 
 15  
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 16  
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 17  
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 18  
 DISCLAIMED. IN NO EVENT SHALL MATTHEW CHAMPION BE LIABLE FOR ANY
 19  
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 20  
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 21  
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 22  
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 23  
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 24  
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 25  
 
 26  
 package com.mattunderscore.filter.contentnegotiation.variantsource;
 27  
 
 28  
 import java.util.List;
 29  
 
 30  
 import com.mattunderscore.filter.contentnegotiation.parser.Variant;
 31  
 
 32  
 /**
 33  
  * A variant source is any object that provides variants to the content negotiation filter.
 34  
  * <P>
 35  
  * This may get variants from an XML configuration file, a database or any other source of
 36  
  * information. This is intended to be more flexible than the deprecated NegotiationXMLParser. It
 37  
  * reuses the the data structures returned by the NegotiationXMLParser.
 38  
  * 
 39  
  * @author Matt Champion
 40  
  * @since 0.2.0
 41  
  */
 42  
 public interface VariantSource
 43  
 {
 44  
     /**
 45  
      * Get the variants from the variant source. The variants are returned a list.
 46  
      * 
 47  
      * @return A list of the variants defined by the variant source
 48  
      * @throws VariantSourceException
 49  
      *             Thrown when unable to return the variants
 50  
      * @throws VariantSourceConfigurationException
 51  
      *             Thrown when the variant source is not configured
 52  
      * @since 0.2.0
 53  
      */
 54  
     public List<Variant> getVariants() throws VariantSourceException;
 55  
 }