Package org.refcodes.console
Class FileOption
- java.lang.Object
-
- org.refcodes.console.AbstractOperand<T>
-
- org.refcodes.console.AbstractOption<java.io.File>
-
- org.refcodes.console.FileOption
-
- All Implemented Interfaces:
java.lang.Comparable<java.io.File>
,org.refcodes.component.Resetable
,ArgsAccessor
,Operand<java.io.File>
,Option<java.io.File>
,Syntaxable
,SyntaxUsage
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<java.io.File>
,org.refcodes.mixin.ValueAccessor<java.io.File>
public class FileOption extends AbstractOption<java.io.File>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
-
Nested classes/interfaces inherited from interface org.refcodes.console.ArgsAccessor
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor
org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends java.lang.Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends java.lang.Object>
-
-
Field Summary
-
Fields inherited from class org.refcodes.console.AbstractOperand
_value
-
-
Constructor Summary
Constructors Constructor Description FileOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new file option.FileOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new file option.FileOption(org.refcodes.structure.Relation<java.lang.String,java.io.File> aProperty)
Instantiates a new file option.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toUsage(SyntaxNotation aSyntaxNotation, java.lang.String aOptionEscCode, java.lang.String aResetEscCode)
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
hierarchy.protected java.io.File
toValue(java.lang.String aArg)
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.-
Methods inherited from class org.refcodes.console.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, reset, toString
-
Methods inherited from class org.refcodes.console.AbstractOption
getLongOption, getOptionPrefixes, getShortOption, parseArgs, setArgs, setValue, toState, toSyntax
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.console.Operand
get, getAlias, getArgs, getValue, hasValue
-
Methods inherited from interface org.refcodes.console.Syntaxable
parseArgs, toSyntax
-
Methods inherited from interface org.refcodes.console.SyntaxUsage
toUsage, toUsage, toUsage
-
-
-
-
Constructor Detail
-
FileOption
public FileOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new file option.- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description
-
FileOption
public FileOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new file option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description
-
FileOption
public FileOption(org.refcodes.structure.Relation<java.lang.String,java.io.File> aProperty)
Instantiates a new file option.- Parameters:
aProperty
- The key (= alias) and the value for the operand.
-
-
Method Detail
-
toValue
protected java.io.File toValue(java.lang.String aArg) throws ParseArgsException
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type. In case conversion failed, then an according exception is to be thrown.- Specified by:
toValue
in classAbstractOperand<java.io.File>
- Parameters:
aArg
- The command line argument to be converted to an instance of the given type T.- Returns:
- An instance of type T from the provided command line argument.
- Throws:
ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.
-
toUsage
public java.lang.String toUsage(SyntaxNotation aSyntaxNotation, java.lang.String aOptionEscCode, java.lang.String aResetEscCode)
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation, String, String)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
or an encapsulating and different type, then the applicable method to be called isSyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toUsage
in interfaceSyntaxUsage
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.aOptionEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option parameters (for example "--help", "-q" and so on).aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-