sbt

State

final case class State(configuration: AppConfiguration, definedCommands: Seq[Command], exitHooks: Set[ExitHook], onFailure: Option[String], remainingCommands: Seq[String], history: History, attributes: AttributeMap, globalLogging: GlobalLogging, 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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new State(configuration: AppConfiguration, definedCommands: Seq[Command], exitHooks: Set[ExitHook], onFailure: Option[String], remainingCommands: Seq[String], history: History, attributes: AttributeMap, globalLogging: GlobalLogging, 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. 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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val attributes: AttributeMap

    custom command state.

    custom command state. It is important to clean up attributes when no longer needed to avoid memory leaks and class loader leaks.

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. lazy val combinedParser: Parser[() ⇒ State]

  10. val configuration: AppConfiguration

    provides access to the launcher environment, including the application configuration, Scala versions, jvm/filesystem wide locking, and the launcher itself

  11. val definedCommands: Seq[Command]

    the list of command definitions that evaluate command strings.

    the list of command definitions that evaluate command strings. These may be modified to change the available commands.

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. final def equals(a: Any): Boolean

    Definition Classes
    Identity → AnyRef → Any
  14. val exitHooks: Set[ExitHook]

    code to run before sbt exits, usually to ensure resources are cleaned up.

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. val globalLogging: GlobalLogging

  18. final def hashCode(): Int

    Definition Classes
    Identity → AnyRef → Any
  19. val history: History

    tracks the recently executed commands

  20. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  22. val next: Next

    the next action for the command processor to take.

    the next action for the command processor to take. This may be to continue with the next command, adjust global logging, or exit.

  23. final def notify(): Unit

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

    Definition Classes
    AnyRef
  25. val onFailure: Option[String]

    the command to execute when another command fails.

    the command to execute when another command fails. onFailure is cleared before the failure handling command is executed.

  26. val remainingCommands: Seq[String]

    the sequence of commands to execute.

    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.

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. final def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Identity

Inherited from AnyRef

Inherited from Any

Ungrouped