An argument that parses multiple input values in order to create a list. More...
Public Member Functions | |
| CollectionArgument (string name, ValueCount valueCount, bool required=true, CollectionType defaultValue=default(CollectionType), string destination=null, string help=null) | |
| Creates a new instance of the argument. More... | |
| override string | Usage (string name=null) |
| override string | Description (string name=null, string alternative=null) |
 Public Member Functions inherited from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType > | |
| ArgumentLiteralParser | GetParser () |
| Fetchs the literal parser for this argument. More... | |
Static Public Member Functions | |
| static CollectionArgument< CollectionType, ValueType > | Create< TargetType, CollectionType, ValueType > (string name, ValueCount valueCount, bool required=true, CollectionType defaultValue=default(CollectionType), Expression< Func< TargetType, CollectionType >> destination=null, string help=null) |
| Creates a new instance of the CollectionArgument. More... | |
Properties | |
| String | ValueStartDelimiter [get, set] |
| The delimiter indicating the start of the combined value. More... | |
| String | ValueEndDelimiter [get, set] |
| The delimiter indicating the end of the combined value. More... | |
| String | ValuePartsConnector [get, set] |
| A term that is used to connect the values from the input list into a single parsed one. More... | |
| bool | KeepDelimiters [get, set] |
| Determiens wether the delimiters are part of the resulting value or not. More... | |
| SimpleTypeConverter< String, ValueType > | TypeConverter [get, set] |
| Properties inherited from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType > | |
| String | Name [get] |
| bool | IsRequired [get] |
Additional Inherited Members | |
| Protected Member Functions inherited from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType > | |
| TargetPropertyArgument (ArgumentReader< ValueType > reader, string name, bool required, ValueType defaultValue, string destination, string help, bool isFlag) | |
| Creates a new instance of the argument. More... | |
| Protected Attributes inherited from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType > | |
| string | helpText |
| TargetPropertyParser< ValueType > | parser |
Detailed Description
An argument that parses multiple input values in order to create a list.
A static class offering convenient ways to create CollectionArguments.
- Remarks
- The number of values that are actually parsed is determined by a count operator which can specify a minimum, a maximum, boundaries, an exact number or all the remaining arguments. This parsing behaviour is also limited by the next recognized argument. See ValueCount for details.
- Since
- 0.2.0
- 0.2.0
- Type Constraints
-
CollectionType : Collection<ValueType> CollectionType : new()
Constructor & Destructor Documentation
◆ CollectionArgument()
| Joutsen.ArgumentsParsing.CollectionArgument< CollectionType, ValueType >.CollectionArgument | ( | string | name, |
| ValueCount | valueCount, | ||
| bool | required = true, |
||
| CollectionType | defaultValue = default(CollectionType), |
||
| string | destination = null, |
||
| string | help = null |
||
| ) |
Creates a new instance of the argument.
- Parameters
-
name the name of the argument valueCount the operator that determines how any values to parse required indicates wether this argument has to appear in the input list or if it is optional defaultValue the value that wil be set onthe target for this argument if it is not required and did not appear int he input list destination the property name of the target instance which shall receive the parsed value. If this is null the name will be used instead. help a help text describing the parameter. It will be used to generate the description of the argument.
Member Function Documentation
◆ Create< TargetType, CollectionType, ValueType >()
|
static |
Creates a new instance of the CollectionArgument.
- Template Parameters
-
TargetType the type of the target object that will receive the parsed values. CollectionType the type of the collection of the argument and the property on the target object ValueType the type of the elements of the collection
- Parameters
-
name the name of the argument valueCount the operator that determines how any values to parse required indicates wether this argument has to appear in the input list or if it is optional defaultValue the value that wil be set onthe target for this argument if it is not required and did not appear int he input list destination an expression describing the property of the target instance which shall recieve the parsed value. If this is null the target property will be found using the name of the argument. help a help text describing the parameter. It will be used to generate the description of the argument.
- Type Constraints
-
CollectionType : Collection<ValueType> CollectionType : new()
◆ Description()
|
virtual |
Reimplemented from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType >.
◆ Usage()
|
virtual |
Reimplemented from Joutsen.ArgumentsParsing.TargetPropertyArgument< CollectionType >.
Property Documentation
◆ KeepDelimiters
|
getset |
Determiens wether the delimiters are part of the resulting value or not.
◆ TypeConverter
|
getset |
◆ ValueEndDelimiter
|
getset |
The delimiter indicating the end of the combined value.
◆ ValuePartsConnector
|
getset |
A term that is used to connect the values from the input list into a single parsed one.
◆ ValueStartDelimiter
|
getset |
The delimiter indicating the start of the combined value.
