case class Parser(name: String, description: String = "") extends ParsedArgument[AnyVal] with Product with Serializable
- Alphabetic
- By Inheritance
- Parser
- Serializable
- Product
- Equals
- ParsedArgument
- BaseArgument
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Parser(name: String, description: String = "")
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addDefault[T](name: String, value: T): Parser
Add a default argument to the current parser
Add a default argument to the current parser
the deepest used parser's default argument will take precedent
- T
the type of the value of the default argument
- name
the name of the default argument
- value
the value the default argument is supposed to take
- returns
the parser itself to chain commands
- Annotations
- @nowarn()
- def addFlag(name: String, short: Char, long: String, description: String = ""): Parser
add a flag
add a flag
- name
the name of the flag
- short
the short name of the flag
- long
the long name of the flag
- description
the description of what the flag affects
- returns
the parser itself to chain commands
- def addOptional[T](name: String, short: Char, long: String, process: (String) => T, default: Option[T] = None, description: String = "")(implicit tag: ClassTag[T]): Parser
add an optional argument
add an optional argument
- T
the type of the final value of the argument
- name
the name of the optional argument
- short
the short name for the optional argument
- long
the long name for the optional argument
- process
the function to process the cmd line string to the argument type
- default
the default value if no argument is provided by the user
- description
the description for the optional argument
- returns
the parser itself to chain commands
- def addPositional[T](name: String, process: (String) => T, description: String)(implicit tag: ClassTag[T]): Parser
add a positional argument
add a positional argument
- T
the type of the finally parsed positional argument after parsing
- name
the name of the positional argument
- process
the function to process the cmd line string to the argument type
- description
the description of the argument
- returns
the parser itself to chain commands
- def addPositional[T](name: String, process: (String) => T)(implicit tag: ClassTag[T]): Parser
add a positional argument
add a positional argument
- name
the name of the positional argument
- returns
the parser itself to chain commands
- def addSubparser(parser: Parser): Parser
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def createCommandString(current: Option[String]): String
- val description: String
- Definition Classes
- Parser → BaseArgument
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getCommandString: String
- Attributes
- protected
- def help(): String
- Definition Classes
- Parser → ParsedArgument
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- Definition Classes
- Parser → BaseArgument
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def parse(args: Iterable[String])(implicit result: ParsingResult): Iterable[String]
- Definition Classes
- Parser → ParsedArgument → BaseArgument
- def parseArgs(args: Iterable[String])(implicit parsingResult: ParsingResult = new ParsingResult()): ParsingResult
- Annotations
- @throws(scala.this.throws.<init>$default$1[de.halcony.argparse.ParsingException])
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def setParent(parent: Parser): Parser
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)