sbt

StateOps

trait StateOps extends AnyRef

Convenience methods for State transformations and operations.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StateOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def +(newCommand: Command): State

    Registers newCommand as an available command.

  2. abstract def ++(newCommands: Seq[Command]): State

    Registers newCommands as available commands.

  3. abstract def ::(command: String): State

    Schedules command to be run before any remaining commands.

  4. abstract def :::(commands: Seq[String]): State

    Schedules commands to be run before any remaining commands.

  5. abstract def addExitHook(f: ⇒ Unit): State

    Registers a new exit hook, which will run when sbt exits or restarts.

  6. abstract def baseDir: File

    The application base directory, which is not necessarily the current working directory.

  7. abstract def classLoaderCache: ClassLoaderCache

    Get the class loader cache for the application.

  8. abstract def clearGlobalLog: State

    Sets the next command processing action to be to rotate the global log and continue executing commands.

  9. abstract def continue: State

    Sets the next command processing action to be to continue processing the next command.

  10. abstract def exit(ok: Boolean): State

    Sets the next command processing action to be to exit with a zero exit code if ok is true and a nonzero exit code if ok if false.

  11. abstract def fail: State

    Marks the currently executing command as failing.

    Marks the currently executing command as failing. This triggers failure handling by the command processor. See also State.onFailure

  12. abstract def get[T](key: AttributeKey[T]): Option[T]

    Gets the value associated with key from the custom attributes map.

  13. abstract def handleError(t: Throwable): State

    Marks the currently executing command as failing due to the given exception.

    Marks the currently executing command as failing due to the given exception. This displays the error appropriately and triggers failure handling by the command processor. Note that this does not throw an exception and returns normally. It is only once control is returned to the command processor that failure handling at the command level occurs.

  14. abstract def has(key: AttributeKey[_]): Boolean

    Returns true if key exists in the custom attributes map, false if it does not exist.

  15. abstract def initializeClassLoaderCache: State

    Create and register a class loader cache.

    Create and register a class loader cache. This should be called once at the application entry-point.

  16. abstract def interactive: Boolean

    An advisory flag that is true if this application will execute commands based on user input.

  17. abstract def keepLastLog: State

    Sets the next command processing action to be to keep the previous log and continue executing commands.

  18. abstract def locked[T](file: File)(t: ⇒ T): T

    Evaluates the provided expression with a JVM-wide and machine-wide lock on file.

  19. abstract def log: Logger

    The Logger used for general command logging.

  20. abstract def process(f: (String, State) ⇒ State): State

  21. abstract def put[T](key: AttributeKey[T], value: T): State

    Sets the value associated with key in the custom attributes map.

  22. abstract def reboot(full: Boolean): State

    Reboots sbt.

    Reboots sbt. A reboot restarts execution from the entry point of the launcher. A reboot is designed to be as close as possible to actually restarting the JVM without actually doing so. Because the JVM is not restarted, JVM exit hooks are not run. State.exitHooks should be used instead and those will be run before rebooting. If full is true, the boot directory is deleted before starting again. This command is currently implemented to not return, but may be implemented in the future to only reboot at the next command processing step.

  23. abstract def reload: State

    Restarts sbt without dropping loaded Scala classes.

    Restarts sbt without dropping loaded Scala classes. It is a shallower restart than reboot. This method takes a snapshot of the remaining commands and will resume executing those commands after reload. This means that any commands added to this State will be dropped.

  24. abstract def remove(key: AttributeKey[_]): State

    Removes the key and any associated value from the custom attributes map.

  25. abstract def runExitHooks(): State

    Runs any defined exitHooks and then clears them.

  26. abstract def setInteractive(flag: Boolean): State

    Changes the advisory interactive flag.

  27. abstract def setNext(n: Next): State

    Sets the next command processing action to do.

  28. abstract def update[T](key: AttributeKey[T])(f: (Option[T]) ⇒ T): State

    Sets the value associated with key in the custom attributes map by transforming the current value.

  29. abstract def setResult(ro: Option[MainResult]): State

    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.0) Use setNext

Concrete 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. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped