Package org.refcodes.console
Enum SyntaxNotation
- java.lang.Object
-
- java.lang.Enum<SyntaxNotation>
-
- org.refcodes.console.SyntaxNotation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SyntaxNotation>
public enum SyntaxNotation extends java.lang.Enum<SyntaxNotation>
TheSyntaxNotation
is used by a theSyntaxable.toSyntax(SyntaxNotation)
method to determine which notation to be used for the generated syntax.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description GNU_POSIX
A syntax notation derived from GNU and POSIX utility conventions and utility argument syntax.REFCODES
A notation which the author of this code believes to unambiguously describe a command line utility's argument syntax; as defined by the means of thisrefcodes-console
artifact.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SyntaxNotation
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SyntaxNotation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
REFCODES
public static final SyntaxNotation REFCODES
A notation which the author of this code believes to unambiguously describe a command line utility's argument syntax; as defined by the means of thisrefcodes-console
artifact.
-
GNU_POSIX
public static final SyntaxNotation GNU_POSIX
A syntax notation derived from GNU and POSIX utility conventions and utility argument syntax.- See Also:
- "http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html", "http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html"
-
-
Method Detail
-
values
public static SyntaxNotation[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SyntaxNotation c : SyntaxNotation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SyntaxNotation valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-