scala.tools.cmd

DemoSpec

trait DemoSpec extends Spec with StdOpts with Interpolation

A sample command specification for illustrative purposes. First take advantage of the meta-options:

// this command creates an executable runner script "demo" % scala scala.tools.cmd.Demo --self-update demo

// this one creates and sources a completion file - note backticks % ./demo --bash

// and now you have a runner with working completion % ./demo --<tab> --action --defint --int --bash --defstr --str --defenv --self-update --unary

The normal option configuration is plausibly self-explanatory.

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DemoSpec
  2. Interpolation
  3. StdOpts
  4. Spec
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type OptionMagic <: Implicit

    Definition Classes
    Spec

Abstract Value Members

  1. abstract def help(str: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Spec
  2. implicit abstract def optionMagicAdditions(s: String): OptionMagic

    Attributes
    protected
    Definition Classes
    Spec

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from DemoSpec to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DemoSpec, B)

    Implicit information
    This member is added by an implicit conversion from DemoSpec to ArrowAssoc[DemoSpec] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. object Bash extends Opt

    I think we're as close as we can get to bundling completion with the program given the constraints imposed by bash.

  9. object SelfUpdate extends Opt

    Generates a very basic runner script.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (DemoSpec) ⇒ Boolean, msg: ⇒ Any): DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to Ensuring[DemoSpec] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (DemoSpec) ⇒ Boolean): DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to Ensuring[DemoSpec] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to Ensuring[DemoSpec] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to Ensuring[DemoSpec] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DemoSpec to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  22. def heading(str: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Spec
  23. object interpolate

    Definition Classes
    Interpolation
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. val optDefault: String

  29. val optDefaultInt: Int

  30. val optEnv: String

  31. val optExpand: Unit

  32. val optIsUnary: Boolean

  33. val optopt: Option[String]

  34. val optoptInt: Option[Int]

  35. lazy val programInfo: Info

    Definition Classes
    DemoSpecSpec
  36. lazy val referenceSpec: DemoSpec.type

    Definition Classes
    DemoSpecSpec
  37. val selfUpdateName: Option[String]

    Definition Classes
    StdOpts
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  39. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def [B](y: B): (DemoSpec, B)

    Implicit information
    This member is added by an implicit conversion from DemoSpec to ArrowAssoc[DemoSpec] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from DemoSpec to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (demoSpec: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from DemoSpec to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (demoSpec: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to ArrowAssoc[DemoSpec] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (demoSpec: ArrowAssoc[DemoSpec]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DemoSpec

    Implicit information
    This member is added by an implicit conversion from DemoSpec to Ensuring[DemoSpec] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (demoSpec: Ensuring[DemoSpec]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Interpolation

Inherited from StdOpts

Inherited from Spec

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DemoSpec to StringAdd

Inherited by implicit conversion any2stringfmt from DemoSpec to StringFormat

Inherited by implicit conversion any2ArrowAssoc from DemoSpec to ArrowAssoc[DemoSpec]

Inherited by implicit conversion any2Ensuring from DemoSpec to Ensuring[DemoSpec]

Ungrouped