Packages

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. onFailure is 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.

Linear Supertypes
Serializable, Serializable, Product, Equals, Identity, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Identity
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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. onFailure is 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

  1. val attributes: AttributeMap
  2. lazy val combinedParser: Parser[() ⇒ State]
  3. val configuration: AppConfiguration
  4. val currentCommand: Option[Exec]
  5. val definedCommands: Seq[Command]
  6. final def equals(a: Any): Boolean
    Definition Classes
    Identity → AnyRef → Any
  7. val exitHooks: Set[ExitHook]
  8. val globalLogging: GlobalLogging
  9. final def hashCode(): Int
    Definition Classes
    Identity → AnyRef → Any
  10. val history: History
  11. val next: Next
  12. val onFailure: Option[Exec]
  13. val remainingCommands: List[Exec]
  14. def source: Option[CommandSource]
  15. final def toString(): String
    Definition Classes
    Identity → AnyRef → Any