Coverage Report - joptsimple.HelpFormatter
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpFormatter
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  
 import java.util.Map;
 29  
 
 30  
 /**
 31  
  * <p>Represents objects charged with taking a set of option descriptions and producing some help text from them.</p>
 32  
  *
 33  
  * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a>
 34  
  */
 35  
 public interface HelpFormatter {
 36  
     /**
 37  
      * Produces help text, given a set of option descriptors.
 38  
      *
 39  
      * @param options descriptors for the configured options of a parser
 40  
      * @return text to be used as help
 41  
      * @see OptionParser#printHelpOn(java.io.Writer)
 42  
      * @see OptionParser#formatHelpWith(HelpFormatter)
 43  
      */
 44  
     String format( Map<String, ? extends OptionDescriptor> options );
 45  
 }