Package org.refcodes.console
Class StringOperandImpl
- java.lang.Object
-
- org.refcodes.console.AbstractOperand<java.lang.String>
-
- org.refcodes.console.StringOperandImpl
-
- All Implemented Interfaces:
java.lang.Comparable<Operand<?>>
,org.refcodes.component.Resetable
,ArgsAccessor
,Operand<java.lang.String>
,Syntaxable
,SyntaxUsage
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<java.lang.String>
,org.refcodes.mixin.ValueAccessor<java.lang.String>
public class StringOperandImpl extends AbstractOperand<java.lang.String>
-
-
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 StringOperandImpl(java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new string operand impl.StringOperandImpl(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)
Instantiates a new string operand impl.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toUsage(SyntaxNotation aSyntaxNotation)
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)
is called from inside aSyntaxable
hierarchy.protected java.lang.String
toValue(java.lang.String aArg)
To value.-
Methods inherited from class org.refcodes.console.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, parseArgs, reset, setArgs, setValue, toState, toString, 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.SyntaxUsage
toUsage, toUsage
-
-
-
-
Constructor Detail
-
StringOperandImpl
public StringOperandImpl(java.lang.String aAlias, java.lang.String aDescription)
Instantiates a new string operand impl.- Parameters:
aAlias
- The identifier to be used when printing the syntax via theAbstractOperand.toSyntax(SyntaxNotation)
method.aDescription
- A description without any line breaks.
-
StringOperandImpl
public StringOperandImpl(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)
Instantiates a new string operand impl.- Parameters:
aProperty
- The key (= alias) and the value for the operand.
-
-
Method Detail
-
toValue
protected java.lang.String toValue(java.lang.String aArg)
To value.- Specified by:
toValue
in classAbstractOperand<java.lang.String>
- Parameters:
aArg
- the arg- Returns:
- the string
-
toUsage
public java.lang.String toUsage(SyntaxNotation aSyntaxNotation)
Description copied from interface:SyntaxUsage
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)
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.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-