Coverage Report - joptsimple.ValueConverter
 
Classes in this File Line Coverage Branch Coverage Complexity
ValueConverter
N/A
N/A
1
 
 1  
 /*
 2  
  The MIT License
 3  
 
 4  
  Copyright (c) 2004-2015 Paul R. Holser, Jr.
 5  
 
 6  
  Permission is hereby granted, free of charge, to any person obtaining
 7  
  a copy of this software and associated documentation files (the
 8  
  "Software"), to deal in the Software without restriction, including
 9  
  without limitation the rights to use, copy, modify, merge, publish,
 10  
  distribute, sublicense, and/or sell copies of the Software, and to
 11  
  permit persons to whom the Software is furnished to do so, subject to
 12  
  the following conditions:
 13  
 
 14  
  The above copyright notice and this permission notice shall be
 15  
  included in all copies or substantial portions of the Software.
 16  
 
 17  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 18  
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 19  
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 20  
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 21  
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 22  
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 23  
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 24  
 */
 25  
 
 26  
 package joptsimple;
 27  
 
 28  
 /**
 29  
  * Instances of this interface are used to convert arguments of options into specific Java types.
 30  
  *
 31  
  * @param <V> constraint on the type of values being converted to
 32  
  * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a>
 33  
  */
 34  
 public interface ValueConverter<V> {
 35  
     /**
 36  
      * Converts the given string value into a Java type.
 37  
      *
 38  
      * @param value the string to convert
 39  
      * @return the converted value
 40  
      * @throws ValueConversionException if a problem occurs while converting the value
 41  
      */
 42  
     V convert( String value );
 43  
 
 44  
     /**
 45  
      * Gives the class of the type of values this converter converts to.
 46  
      *
 47  
      * @return the target class for conversion
 48  
      */
 49  
     Class<? extends V> valueType();
 50  
 
 51  
     /**
 52  
      * Gives a string that describes the pattern of the values this converter expects, if any.  For example, a date
 53  
      * converter can respond with a {@link java.text.SimpleDateFormat date format string}.
 54  
      *
 55  
      * @return a value pattern, or {@code null} if there's nothing interesting here
 56  
      */
 57  
     String valuePattern();
 58  
 }