Java Doc for OptionBuilder.java in » Library » Apache-command-line » org » apache » commons » cli » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Library » Apache command line » org.apache.commons.cli

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.commons.cli .OptionBuilder

OptionBuilder

public class OptionBuilder (Code)

OptionBuilder allows the user to create Options using descriptive methods.

Details on the Builder pattern can be found at http://c2.com/cgi-bin/wiki?BuilderPattern.

author:
John Keyes (john at integralsource.com)
since:
1.0

Method Summary
public static Option	create(char opt) Create an Option using the current settings and with the specified Option `char`. Parameters: opt - the character representation of the Option the Option instance throws: IllegalArgumentException - if `opt` is nota valid character.
public static Option	create() Create an Option using the current settings the Option instance throws: IllegalArgumentException - if `longOpt` hasnot been set.
public static Option	create(String opt) Create an Option using the current settings and with the specified Option `char`. Parameters: opt - the `java.lang.String` representation of the Option the Option instance throws: IllegalArgumentException - if `opt` is nota valid character.
public static OptionBuilder	hasArg() The next Option created will require an argument value.
public static OptionBuilder	hasArg(boolean hasArg) The next Option created will require an argument value if `hasArg` is true.
public static OptionBuilder	hasArgs() The next Option created can have unlimited argument values.
public static OptionBuilder	hasArgs(int num) The next Option created can have `num` argument values.
public static OptionBuilder	hasOptionalArg() The next Option can have an optional argument.
public static OptionBuilder	hasOptionalArgs() The next Option can have an unlimited number of optional arguments.
public static OptionBuilder	hasOptionalArgs(int numArgs) The next Option can have the specified number of optional arguments. Parameters: numArgs - - the maximum number of optional argumentsthe next Option created can have.
public static OptionBuilder	isRequired() The next Option created will be required.
public static OptionBuilder	isRequired(boolean newRequired) The next Option created will be required if `required` is true.
public static OptionBuilder	withArgName(String name) The next Option created will have the specified argument value name.
public static OptionBuilder	withDescription(String newDescription)
public static OptionBuilder	withLongOpt(String newLongopt) The next Option created will have the following long option value.
public static OptionBuilder	withType(Object newType) The next Option created will have a value that will be an instance of `type`.
public static OptionBuilder	withValueSeparator(char sep) The next Option created uses `sep` as a means to separate argument values. Example: Option opt = OptionBuilder.withValueSeparator(':') .create('D'); CommandLine line = parser.parse(args); String propertyName = opt.getValue(0); String propertyValue = opt.getValue(1); Parameters: sep - The value separator to be used for the argument values.
public static OptionBuilder	withValueSeparator() The next Option created uses '`=`' as a means to separate argument values.

Method Detail

create
public static Option create(char opt) throws IllegalArgumentException(Code)
	Create an Option using the current settings and with the specified Option `char`. Parameters: opt - the character representation of the Option the Option instance throws: IllegalArgumentException - if `opt` is nota valid character. See Option.

create
public static Option create() throws IllegalArgumentException(Code)
	Create an Option using the current settings the Option instance throws: IllegalArgumentException - if `longOpt` hasnot been set.

create
public static Option create(String opt) throws IllegalArgumentException(Code)
	Create an Option using the current settings and with the specified Option `char`. Parameters: opt - the `java.lang.String` representation of the Option the Option instance throws: IllegalArgumentException - if `opt` is nota valid character. See Option.

hasArg
public static OptionBuilder hasArg()(Code)
	The next Option created will require an argument value. the OptionBuilder instance

hasArg
public static OptionBuilder hasArg(boolean hasArg)(Code)
	The next Option created will require an argument value if `hasArg` is true. Parameters: hasArg - if true then the Option has an argument value the OptionBuilder instance

hasArgs
public static OptionBuilder hasArgs()(Code)
	The next Option created can have unlimited argument values. the OptionBuilder instance

hasArgs
public static OptionBuilder hasArgs(int num)(Code)
	The next Option created can have `num` argument values. Parameters: num - the number of args that the option can have the OptionBuilder instance

hasOptionalArg
public static OptionBuilder hasOptionalArg()(Code)
	The next Option can have an optional argument. the OptionBuilder instance

hasOptionalArgs
public static OptionBuilder hasOptionalArgs()(Code)
	The next Option can have an unlimited number of optional arguments. the OptionBuilder instance

hasOptionalArgs
public static OptionBuilder hasOptionalArgs(int numArgs)(Code)
	The next Option can have the specified number of optional arguments. Parameters: numArgs - - the maximum number of optional argumentsthe next Option created can have. the OptionBuilder instance

isRequired
public static OptionBuilder isRequired()(Code)
	The next Option created will be required. the OptionBuilder instance

isRequired
public static OptionBuilder isRequired(boolean newRequired)(Code)
	The next Option created will be required if `required` is true. Parameters: newRequired - if true then the Option is required the OptionBuilder instance

withArgName
public static OptionBuilder withArgName(String name)(Code)
	The next Option created will have the specified argument value name. Parameters: name - the name for the argument value the OptionBuilder instance

withDescription
public static OptionBuilder withDescription(String newDescription)(Code)
	The next Option created will have the specified description Parameters: newDescription - a description of the Option's purpose the OptionBuilder instance

withLongOpt
public static OptionBuilder withLongOpt(String newLongopt)(Code)
	The next Option created will have the following long option value. Parameters: newLongopt - the long option value the OptionBuilder instance

withType
public static OptionBuilder withType(Object newType)(Code)
	The next Option created will have a value that will be an instance of `type`. Parameters: newType - the type of the Options argument value the OptionBuilder instance

withValueSeparator
public static OptionBuilder withValueSeparator(char sep)(Code)
	The next Option created uses `sep` as a means to separate argument values. Example: Option opt = OptionBuilder.withValueSeparator(':') .create('D'); CommandLine line = parser.parse(args); String propertyName = opt.getValue(0); String propertyValue = opt.getValue(1); Parameters: sep - The value separator to be used for the argument values. the OptionBuilder instance

withValueSeparator
public static OptionBuilder withValueSeparator()(Code)
	The next Option created uses '`=`' as a means to separate argument values. Example: Option opt = OptionBuilder.withValueSeparator() .create('D'); CommandLine line = parser.parse(args); String propertyName = opt.getValue(0); String propertyValue = opt.getValue(1); the OptionBuilder instance

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.