class Shell extends BareShell
A utility for working with command line options. This comes prepopulated with common options for most uses.
- Source
- Shell.scala
- Alphabetic
- By Inheritance
- Shell
- BareShell
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Shell(applicationName: String)
- applicationName
the application associated with these command line options
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Shell, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val applicationName: String
- Definition Classes
- BareShell
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Shell) => Boolean, msg: => Any): Shell
- def ensuring(cond: (Shell) => Boolean): Shell
- def ensuring(cond: Boolean, msg: => Any): Shell
- def ensuring(cond: Boolean): Shell
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parse(args: Array[String], initAnnos: AnnotationSeq = Seq.empty): AnnotationSeq
The AnnotationSeq generated from command line arguments
The AnnotationSeq generated from command line arguments
This requires lazy evaluation as subclasses will mixin new command line options via methods of Shell.parser
- Definition Classes
- BareShell
- val parser: OptionParser[AnnotationSeq] with DuplicateHandling with ExceptOnError
Command line argument parser (OptionParser) with modifications
Command line argument parser (OptionParser) with modifications
- Attributes
- protected
- Definition Classes
- BareShell
- def parserSetup(): Unit
This method can be overriden to do some work everytime before parsing runs, e.g., to add options to the parser.
- final lazy val registeredLibraries: Seq[RegisteredLibrary]
Contains all discovered RegisteredLibrary
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Shell toStringFormat[Shell] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Shell, B)
- Implicit
- This member is added by an implicit conversion from Shell toArrowAssoc[Shell] 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.