TestArgumentContainer **BETA**

Argument container class for testing documentation generation.

Category Test feature group name


Overview

Argument container class for testing documentation generation. Contains an argument for each @Argument, @ArgumentCollection, and @DocumentedFeature property that should be tested. Test custom tag: {@MyTag.Type testType}

The purpose of this paragraph is to test embedded html formatting.

  1. This is point number 1
  2. This is point number 2


Additional Information

Test Plugins

This Test Plugin is automatically applied to the data by the Engine before processing by TestArgumentContainer.


Command-line Arguments

Additional References

See these additional references for more information.

TestArgumentContainer specific arguments

This table summarizes the command-line arguments that are specific to this tool. For more details on each argument, see the list further down below the table or click on an argument name to jump directly to that entry in the list.

Argument name(s) Default value Summary
Positional Arguments
[NA - Positional]
NA (Deprecated) Positional arguments, min = 2, max = 2
Required Arguments
--enumCollection
[] Undocumented option
--nonCLPEnumCollection
[] Undocumented option
--requiredClpEnum
null Required Clp enum
--requiredFileList
 -reqFilList
[] Required file list
--requiredInputFilesFromArgCollection
 -rRequiredInputFilesFromArgCollection
[] Required input files from argument collection
--requiredStringInputFromArgCollection
null Required string input from argument collection
--requiredStringList
 -reqStrList
[] A required list of strings
--usesFieldNameForArgName
null Use field name if no name in annotation.
Optional Tool Arguments
--deprecatedString
 -depStr
0 (Deprecated) deprecated
--enumSetLong
 -ES
[ENUM_VALUE_1] Some set thing.
--fullAnonymousArgName
 -anonymousClassArg
[] Test anonymous class arg
--mutexSourceField
[] Undocumented option
--mutexTargetField1
[] SAM/BAM/CRAM file(s) with alignment data from the first read of a pair.
--mutexTargetField2
[] SAM/BAM file(s) with alignment data from the second read of a pair.
--optionalClpEnum
ENUM_VALUE_1 Optional Clp enum
--optionalDouble
 -optDouble
2.15 Optionals double with initial value 2.15
--optionalDoubleList
 -optDoubleList
[100.0, 99.9, 99.0, 90.0] optionalDoubleList with initial values: 100.0, 99.9, 99.0, 90.0
--optionalFileList
 -optFilList
[] Optional file list
--optionalFlag
 -optFlag
false Optional flag, defaults to false.
--optionalInputFilesFromArgCollection
[] Optional input files from argument collection
--optionalStringInputFromArgCollection
null Optional string input from argument collection
--optionalStringList
 -optStrList
[] An optional list of strings
--testPlugin
[] Undocumented option
Advanced Arguments
--advancedOptionalInt
 -advancedOptInt
1 advancedOptionalInt with initial value 1
Deprecated Arguments
[NA - Positional]
NA (Deprecated) Positional arguments, min = 2, max = 2
--deprecatedString
 -depStr
0 (Deprecated) deprecated

Argument details

Arguments in this list are specific to this tool. Keep in mind that other arguments are available that are shared with other tools (e.g. command-line GATK arguments); see Inherited arguments above.


[NA - Positional]

This argument is deprecated. This feature is deprecated and will be removed in a future release.
Positional arguments, min = 2, max = 2
Positional arguments, min = 2, max = 2

R List[File]  NA


--advancedOptionalInt / -advancedOptInt

advancedOptionalInt with initial value 1
Advanced, Optional int

int  1  [ [ -∞  ∞ ] ]


--deprecatedString / -depStr

This argument is deprecated. Too hard to support.
deprecated
Deprecated string

int  0  [ [ -∞  ∞ ] ]


--enumCollection

Undocumented option

The --enumCollection argument is an enumerated type (List[TestEnum]), which can have one of the following values:

ENUM_VALUE_1
This is enum value 1.
ENUM_VALUE_2
This is enum value 2.

R List[TestEnum]  []


--enumSetLong / -ES

Some set thing.

The --enumSetLong argument is an enumerated type (EnumSet[TestEnum]), which can have one of the following values:

ENUM_VALUE_1
This is enum value 1.
ENUM_VALUE_2
This is enum value 2.

EnumSet[TestEnum]  [ENUM_VALUE_1]


--fullAnonymousArgName / -anonymousClassArg

Test anonymous class arg

List[File]  []


--mutexSourceField / -mutexSourceField

Undocumented option
Mutually exclusive args

Exclusion: This argument cannot be used at the same time as mutexTargetField1, mutexTargetField2.

List[File]  []


--mutexTargetField1 / -mutexTargetField1

SAM/BAM/CRAM file(s) with alignment data from the first read of a pair.

Exclusion: This argument cannot be used at the same time as mutexSourceField.

List[File]  []


--mutexTargetField2 / -mutexTargetField2

SAM/BAM file(s) with alignment data from the second read of a pair.

Exclusion: This argument cannot be used at the same time as mutexSourceField.

List[File]  []


--nonCLPEnumCollection

Undocumented option

The --nonCLPEnumCollection argument is an enumerated type (List[TestNonCLPEnum]), which can have one of the following values:

NON_CLP_ENUM_VALUE_1
This is the NON_CLP_ENUM_VALUE_1 comment
NON_CLP_ENUM_VALUE_2
This is the NON_CLP_ENUM_VALUE_2 comment

R List[TestNonCLPEnum]  []


--optionalClpEnum / -optionalClpEnum

Optional Clp enum

The --optionalClpEnum argument is an enumerated type (TestEnum), which can have one of the following values:

ENUM_VALUE_1
This is enum value 1.
ENUM_VALUE_2
This is enum value 2.

TestEnum  ENUM_VALUE_1


--optionalDouble / -optDouble

Optionals double with initial value 2.15
Required double

double  2.15  [ [ -∞  ∞ ] ]


--optionalDoubleList / -optDoubleList

optionalDoubleList with initial values: 100.0, 99.9, 99.0, 90.0
Optional double list.

List[Double]  [100.0, 99.9, 99.0, 90.0]


--optionalFileList / -optFilList

Optional file list
Optional file list.

List[File]  []


--optionalFlag / -optFlag

Optional flag, defaults to false.
Optional flag.

boolean  false


--optionalInputFilesFromArgCollection / -optionalInputFilesFromArgCollection

Optional input files from argument collection

List[File]  []


--optionalStringInputFromArgCollection / -optionalStringInputFromArgCollection

Optional string input from argument collection

String  null


--optionalStringList / -optStrList

An optional list of strings
Optional string list.

List[String]  []


--requiredClpEnum / -requiredClpEnum

Required Clp enum

The --requiredClpEnum argument is an enumerated type (TestEnum), which can have one of the following values:

ENUM_VALUE_1
This is enum value 1.
ENUM_VALUE_2
This is enum value 2.

R TestEnum  null


--requiredFileList / -reqFilList

Required file list
Required file list.

R List[File]  []


--requiredInputFilesFromArgCollection / -rRequiredInputFilesFromArgCollection

Required input files from argument collection

R List[File]  []


--requiredStringInputFromArgCollection / -requiredStringInputFromArgCollection

Required string input from argument collection

R String  null


--requiredStringList / -reqStrList

A required list of strings
Required string list.

R List[String]  []


--testPlugin

Undocumented option

List[String]  []


--usesFieldNameForArgName

Use field name if no name in annotation.

R String  null


Return to top


Barclay version 11.1 built at 2016/01/01 01:01:01.