c

firrtl.options

ShellOption

final class ShellOption[A] extends AnyRef

Contains information about a Shell command line option

Source
Registration.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShellOption
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ShellOption(longOption: String, toAnnotationSeq: (A) => AnnotationSeq, helpText: String, shortOption: Option[String] = None, helpValueName: Option[String] = None)(implicit arg0: Read[A])

    longOption

    a long, double-dash option

    toAnnotationSeq

    a function to convert the type into an AnnotationSeq

    helpText

    help text

    shortOption

    an optional single-dash option

    helpValueName

    a string to show as a placeholder argument in help text

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toany2stringadd[ShellOption[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShellOption[A], B)
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toArrowAssoc[ShellOption[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def addOption(p: OptionParser[AnnotationSeq]): Unit

    Add this specific shell (command line) option to an option parser

    Add this specific shell (command line) option to an option parser

    p

    an option parser

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def ensuring(cond: (ShellOption[A]) => Boolean, msg: => Any): ShellOption[A]
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toEnsuring[ShellOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ShellOption[A]) => Boolean): ShellOption[A]
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toEnsuring[ShellOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ShellOption[A]
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toEnsuring[ShellOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ShellOption[A]
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toEnsuring[ShellOption[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val helpText: String
  19. val helpValueName: Option[String]
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val longOption: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val shortOption: Option[String]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val toAnnotationSeq: (A) => AnnotationSeq
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toStringFormat[ShellOption[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ShellOption[A], B)
    Implicit
    This member is added by an implicit conversion from ShellOption[A] toArrowAssoc[ShellOption[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromShellOption[A] to any2stringadd[ShellOption[A]]

Inherited by implicit conversion StringFormat fromShellOption[A] to StringFormat[ShellOption[A]]

Inherited by implicit conversion Ensuring fromShellOption[A] to Ensuring[ShellOption[A]]

Inherited by implicit conversion ArrowAssoc fromShellOption[A] to ArrowAssoc[ShellOption[A]]

Ungrouped