Object/Class

com.phasmidsoftware.args

Args

Related Docs: class Args | package args

Permalink

object Args extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Args
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def create(args: Arg[String]*): Args[String]

    Permalink

    Method to create an Args object from a variable number of Arg parameters.

    Method to create an Args object from a variable number of Arg parameters.

    NOTE: this is normally used only for testing.

    args

    the command line arguments.

    returns

    the arguments parsed as an Args[String].

  7. def empty[T]: Args[T]

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def make(args: Seq[String]): Args[String]

    Permalink

    Method to create an Args[String] from the command line arguments in a main program (or a sub-class of App).

    Method to create an Args[String] from the command line arguments in a main program (or a sub-class of App).

    NOTE that we use get here on a Try. We might throw an exception, therefore.

    args

    a Seq[String].

    returns

    an Args[String]

    Exceptions thrown

    Exception the result of invoking parse.

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def parse(args: Array[String], synopsis: Option[String] = None): Try[Args[String]]

    Permalink

    Method to parse a set of command line arguments that conform to the POSIX standard.

    Method to parse a set of command line arguments that conform to the POSIX standard.

    args

    the command line arguments.

    synopsis

    the (optional) syntax template which will be used, if not None, to validate the options.

    returns

    the arguments parsed as an Args[String], wrapped in Try.

  19. def parseSimple(args: Array[String]): Try[Args[String]]

    Permalink

    Method to parse a set of command line arguments that don't necessarily conform to the POSIX standard, and which cannot be validated.

    Method to parse a set of command line arguments that don't necessarily conform to the POSIX standard, and which cannot be validated.

    args

    the command line arguments.

    returns

    the arguments parsed as an Args[String], wrapped in Try.

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped