gnu.getopt.gnu.getopt.LongOpt.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-getopt Show documentation
GNU Getopt - Java port, with type annotations
The newest version!






  Class gnu.getopt.LongOpt




All Packages  Class Hierarchy  This Package  Previous  Next  Index


  Class gnu.getopt.LongOpt

java.lang.Object
   |
   +----gnu.getopt.LongOpt



   public class LongOpt
  
 extends Object

This object represents the definition of a long option in the Java port
 of GNU getopt.  An array of LongOpt objects is passed to the Getopt
 object to define the list of valid long options for a given parsing
 session.  Refer to the getopt documentation for details on the
 format of long options.


   Version:
  
 1.0.3
  
 Author:
  
 Aaron M. Renn ([email protected])
    
 See Also:
    
 Getopt




  


   
	NO_ARGUMENT
  
  Constant value used for the "has_arg" constructor argument.
  
 
	OPTIONAL_ARGUMENT
  
  Constant value used for the "has_arg" constructor argument.
  
 
	REQUIRED_ARGUMENT
  
 
 Constant value used for the "has_arg" constructor argument.


  


   
	LongOpt(String, int, StringBuffer, int)
  
  Create a new LongOpt object with the given parameter values.


  


   
	getFlag()
  
  Returns the value of the 'flag' field for this long option

 
  
 
	getHasArg()
  
  Returns the value set for the 'has_arg' field for this long option

 
  
 
	getName()
  
  Returns the name of this LongOpt as a String

 
  
 
	getVal()
  
  Returns the value of the 'val' field for this long option

 



  


NO_ARGUMENT
 public static final int NO_ARGUMENT


   Constant value used for the "has_arg" constructor argument.  This
 value indicates that the option takes no argument.


REQUIRED_ARGUMENT
 public static final int REQUIRED_ARGUMENT


   Constant value used for the "has_arg" constructor argument.  This
 value indicates that the option takes an argument that is required.


OPTIONAL_ARGUMENT
 public static final int OPTIONAL_ARGUMENT


   Constant value used for the "has_arg" constructor argument.  This
 value indicates that the option takes an argument that is optional.



  



LongOpt
 public LongOpt(String name,
                int has_arg,
                StringBuffer flag,
                int val) throws IllegalArgumentException


   Create a new LongOpt object with the given parameter values.  If the
 value passed as has_arg is not valid, then an exception is thrown.

  

     Parameters:
    
 name - The long option String.
    
 has_arg - Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT).
    
 flag - If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character.
    
 val - The value to return for this long option, or the equivalent single letter option to emulate if flag is null.
    
 Throws: IllegalArgumentException
    
 If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT.
  



  


getName
 public String getName()


   Returns the name of this LongOpt as a String

  

     Returns:
    
 Then name of the long option
  


getHasArg
 public int getHasArg()


   Returns the value set for the 'has_arg' field for this long option

  

     Returns:
    
 The value of 'has_arg'
  


getFlag
 public StringBuffer getFlag()


   Returns the value of the 'flag' field for this long option

  

     Returns:
    
 The value of 'flag'
  


getVal
 public int getVal()


   Returns the value of the 'val' field for this long option

  

     Returns:
    
 The value of 'val'
  


All Packages  Class Hierarchy  This Package  Previous  Next  Index