Class

com.vbounyasit.bigdata.args

ArgumentsParser

Related Doc: package args

Permalink

class ArgumentsParser[T] extends AnyRef

A definition used to parse input arguments while running an application

T

The case class data type containing the loaded arguments

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArgumentsParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ArgumentsParser(name: String, defaultArguments: T, argumentsConfiguration: Map[String, ArgumentDefinition[T]])

    Permalink

    name

    The argument definition name

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 buildArguments(argsConfig: Map[String, ArgumentDefinition[T]]): OParser[_, T]

    Permalink

    Builds the argument parsing sequence based on the provided configuration with OParser

    Builds the argument parsing sequence based on the provided configuration with OParser

    argsConfig

    A map with the correct argument definitions

    returns

    an OParser object that has all the parsing configurations setup

  6. val builder: OParserBuilder[T]

    Permalink

    The parser builder

    The parser builder

    Attributes
    protected
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. def parseArguments(appName: String, args: Array[String]): Either[ParseArgumentsError, T]

    Permalink

    Parses A list of arguments provided through the command line in the 'main' method

    Parses A list of arguments provided through the command line in the 'main' method

    appName

    The application name

    args

    The args parameter provided by the main function

    returns

    Either the resulting Arguments object or an error

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped