final case class State(configuration: AppConfiguration, definedCommands: Seq[Command], exitHooks: Set[ExitHook], onFailure: Option[Exec], remainingCommands: List[Exec], history: History, attributes: AttributeMap, globalLogging: GlobalLogging, currentCommand: Option[Exec], next: Next) extends Identity with Product with Serializable
Data structure representing all command execution information.
- configuration
provides access to the launcher environment, including the application configuration, Scala versions, jvm/filesystem wide locking, and the launcher itself
- definedCommands
the list of command definitions that evaluate command strings. These may be modified to change the available commands.
- exitHooks
code to run before sbt exits, usually to ensure resources are cleaned up.
- onFailure
the command to execute when another command fails.
onFailureis cleared before the failure handling command is executed.- remainingCommands
the sequence of commands to execute. This sequence may be modified to change the commands to be executed. Typically, the
::and:::methods are used to prepend new commands to run.- history
tracks the recently executed commands
- attributes
custom command state. It is important to clean up attributes when no longer needed to avoid memory leaks and class loader leaks.
- next
the next action for the command processor to take. This may be to continue with the next command, adjust global logging, or exit.
- Alphabetic
- By Inheritance
- State
- Serializable
- Serializable
- Product
- Equals
- Identity
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
State(configuration: AppConfiguration, definedCommands: Seq[Command], exitHooks: Set[ExitHook], onFailure: Option[Exec], remainingCommands: List[Exec], history: History, attributes: AttributeMap, globalLogging: GlobalLogging, currentCommand: Option[Exec], next: Next)
- configuration
provides access to the launcher environment, including the application configuration, Scala versions, jvm/filesystem wide locking, and the launcher itself
- definedCommands
the list of command definitions that evaluate command strings. These may be modified to change the available commands.
- exitHooks
code to run before sbt exits, usually to ensure resources are cleaned up.
- onFailure
the command to execute when another command fails.
onFailureis cleared before the failure handling command is executed.- remainingCommands
the sequence of commands to execute. This sequence may be modified to change the commands to be executed. Typically, the
::and:::methods are used to prepend new commands to run.- history
tracks the recently executed commands
- attributes
custom command state. It is important to clean up attributes when no longer needed to avoid memory leaks and class loader leaks.
- next
the next action for the command processor to take. This may be to continue with the next command, adjust global logging, or exit.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val attributes: AttributeMap
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- lazy val combinedParser: Parser[() ⇒ State]
- val configuration: AppConfiguration
- val currentCommand: Option[Exec]
- val definedCommands: Seq[Command]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
equals(a: Any): Boolean
- Definition Classes
- Identity → AnyRef → Any
- val exitHooks: Set[ExitHook]
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val globalLogging: GlobalLogging
-
final
def
hashCode(): Int
- Definition Classes
- Identity → AnyRef → Any
- val history: History
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val next: Next
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val onFailure: Option[Exec]
- val remainingCommands: List[Exec]
- def source: Option[CommandSource]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toString(): String
- Definition Classes
- Identity → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()