Class
Tree
          
PREV CLASS NEXT CLASS
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD
  
com.newstep.solid.util
Class Option
public class Option      
Command line option + utilities for parsing and representing
unix like command options.
Author:
msimonsen
 
Links:
Kernel Association Association Link
to Interface OptionRule
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
 
 
Field Summary
Pattern
boolean
boolean
String
String
public static String
private String
private boolean
Pattern
private OptionRule
private String
private boolean
Constructor Summary
public void
Option(String name, String value, Boolean optional, Boolean valueReq)
public void
Option(String name, String value, Boolean optional)
public void
Option(String name, String value)
Method Summary
public static Option
findOptionByName(String name, List options)
public double
public float
public int
public long
public String
public Pattern
public OptionRule
public String
public boolean
public boolean
public static List
parse(String args, Option defaults)
public static List
parse(String args)
public static Map
parseToMap(String args, Option defaults)
public void
setName(String name)
public void
setOptional(Boolean optional)
public void
setPattern(Pattern pattern)
public void
public void
setValue(String value)
public void
setValueReq(Boolean valueReq)
public String
public static List
validateOptionals(Option predetermined, List verifiable)
Field Detail
blank
public static String blank
Multiplicity:
1
Static.
 
name
private String name
Multiplicity:
1
 
name
String name
 
optional
boolean optional
 
optional
private boolean optional
Multiplicity:
1
 
pattern
Pattern pattern
 
pattern
Pattern pattern
Multiplicity:
1
 
rule
OptionRule rule
 
rule
private OptionRule rule
Multiplicity:
1
 
value
private String value
Multiplicity:
1
 
value
String value
 
valueReq
private boolean valueReq
Multiplicity:
1
 
valueReq
boolean valueReq
 
Constructor Detail
Option
public void Option (String name, String value, Boolean optional, Boolean valueReq)
 
Stereotype:
create
 
Option
public void Option (String name, String value, Boolean optional)
 
Stereotype:
create
 
Option
public void Option (String name, String value)
 
Stereotype:
create
 
Method Detail
findOptionByName
public static Option findOptionByName (String name, List options)
 
Utility to find an option from a List of options.

Finds an option by name. Returns null if none found.
Parameters:
name
options
Return:
Option found or null
Static.
 
getDoubleValue
public double getDoubleValue ()
 
 
getFloatValue
public float getFloatValue ()
 
 
getIntValue
public int getIntValue ()
 
 
getLongValue
public long getLongValue ()
 
 
getName
public String getName ()
 
 
getPattern
public Pattern getPattern ()
 
 
getRule
public OptionRule getRule ()
 
 
getValue
public String getValue ()
 
 
isOptional
public boolean isOptional ()
 
 
isValueReq
public boolean isValueReq ()
 
 
parse
public static List parse (String args, Option defaults)
 
Parses a string array thats been tokenizen by the
command line input for instance.
Parameters:
args - tokenized arguments, usually from command line
defaults - Default options
Return:
List of Options
Static.
 
parse
public static List parse (String args)
 
Parses a string that corresponds to
Parameters:
args - Unparsed string of delimited tokens - to be parsed
Static.
 
parseToMap
public static Map parseToMap (String args, Option defaults)
 
Parses a string array thats been tokenizen by the
command line input for instance. Places in a map that
is keyed by the name.
Parameters:
args
defaults
Return:
Map of argument keys to Options
Static.
 
setName
public void setName (String name)
 
 
setOptional
public void setOptional (Boolean optional)
 
 
setPattern
public void setPattern (Pattern pattern)
 
 
setRule
public void setRule (OptionRule rule)
 
 
setValue
public void setValue (String value)
 
 
setValueReq
public void setValueReq (Boolean valueReq)
 
 
toString
public String toString ()
 
 
validateOptionals
public static List validateOptionals (Option predetermined, List verifiable)
 
Returns the missing required from a list pre-determined options.
Not implemented.
Parameters:
predetermined - the set of predetermined options
verifiable - list of options
Return:
List of options
Static.
 
Class
Tree
          
PREV CLASS NEXT CLASS
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD