Packages

case class HelpAction(topic: String) extends PrintAction with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HelpAction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PrintAction
  7. ResponsiveAction
  8. Action
  9. MMTTask
  10. Killable
  11. Extension
  12. Logger
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HelpAction(topic: String)

Type Members

  1. case class LocalError(s: String) extends ExtensionError with Product with Serializable

    a custom error class for this extension

    a custom error class for this extension

    Definition Classes
    Extension

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addListener(l: MMTTaskProgressListener): Unit
    Definition Classes
    MMTTask
  5. def apply(): Unit

    executes this Action

    executes this Action

    Definition Classes
    HelpAction → Action
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def catchErrors[A](msg: String, recoverWith: ⇒ A)(code: ⇒ A): A

    like its partner but with return value

    like its partner but with return value

    Attributes
    protected
    Definition Classes
    Extension
  8. def catchErrors(msg: String)(code: ⇒ Unit): Unit

    convenience method for wrapping code in error handler that throws LocalError

    convenience method for wrapping code in error handler that throws LocalError

    Attributes
    protected
    Definition Classes
    Extension
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val controller: Controller

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    the controller that this extension is added to; only valid after creation of the extension, i.e., will return null if used in a non-lazy val-field

    Attributes
    protected
    Definition Classes
    Extension
  11. lazy val defaultPrefix: String
    Definition Classes
    Extension
  12. def destroy: Unit

    extension-specific cleanup (override as needed, empty by default)

    extension-specific cleanup (override as needed, empty by default)

    Extensions may create persistent data structures and threads, but they must clean up after themselves in this method

    Definition Classes
    Extension
  13. def destroyWhenRemainingTasksFinished: Unit

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    convenience for calling waitUntilRemainingTasksFinished and then destroy

    Definition Classes
    Extension
  14. def diesWith(implicit that: Killable): HelpAction.this.type

    gives a killable object the same kill button as one that is already around

    gives a killable object the same kill button as one that is already around

    For example, when processing a task, generates a subtask, this should be called on the subtask to ensure killing the overall task also kills the subtask.

    Definition Classes
    Killable
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getFromFirstArgOrEnvvar(args: List[String], name: String, default: String = ""): String
    Attributes
    protected
    Definition Classes
    Extension
  19. def getReports: List[MMTTaskProgress]

    get all reports in reverse chronological order

    get all reports in reverse chronological order

    Definition Classes
    MMTTask
  20. def initOther(e: Extension): Unit

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    any extension can initialize other extensions if those are not meant to be added to the ExtensionManager

    Attributes
    protected
    Definition Classes
    Extension
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isKilled: Boolean

    processing should be aborted gracefully if true

    processing should be aborted gracefully if true

    Definition Classes
    Killable
  23. def kill: Unit

    signals aborting of processing

    signals aborting of processing

    Definition Classes
    Killable
  24. def log(e: Error): Unit

    logs an error - always logged

    logs an error - always logged

    Attributes
    protected
    Definition Classes
    Logger
  25. def log(s: ⇒ String, subgroup: Option[String] = None): Unit

    logs a message with this logger's logprefix

    logs a message with this logger's logprefix

    Attributes
    protected
    Definition Classes
    Logger
  26. def logError(s: ⇒ String): Unit

    log as an error message

    log as an error message

    Attributes
    protected
    Definition Classes
    Logger
  27. def logGroup[A](a: ⇒ A): A

    wraps around a group to create nested logging

    wraps around a group to create nested logging

    Attributes
    protected
    Definition Classes
    Logger
  28. def logPrefix: String

    the prefix used to identify this extension for logging, by default the class name

    the prefix used to identify this extension for logging, by default the class name

    Definition Classes
    Action → Extension → Logger
  29. def logTemp(s: ⇒ String): Unit

    temporary logging - always logged

    temporary logging - always logged

    Attributes
    protected
    Definition Classes
    Logger
  30. def makeErrorThrower(msg: String): ErrorHandler

    an ErrorHandler that wraps an error in a LocalError and throws it

    an ErrorHandler that wraps an error in a LocalError and throws it

    Attributes
    protected
    Definition Classes
    Extension
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def removeListener(l: MMTTaskProgressListener): Unit
    Definition Classes
    MMTTask
  35. val report: Report
    Attributes
    protected
    Definition Classes
    Extension → Logger
  36. def reportProgress(a: MMTTaskProgress): Unit

    adds a report and forwards it to all listeners

    adds a report and forwards it to all listeners

    Definition Classes
    MMTTask
  37. def respond(x: Any*): Unit

    prints a response to the caller

    prints a response to the caller

    Definition Classes
    ResponsiveAction
  38. def setTimeout[A](millisec: Int)(f: () ⇒ Unit): HelpAction.this.type

    presses the kill button after the specified number of milli seconds

    presses the kill button after the specified number of milli seconds

    Definition Classes
    Killable
  39. def start(args: List[String]): Unit

    extension-specific initialization (override as needed, empty by default)

    extension-specific initialization (override as needed, empty by default)

    Definition Classes
    Extension
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toParseString: String

    returns this action as a parsable string

    returns this action as a parsable string

    Definition Classes
    HelpAction → Action
  42. def toString(): String
    Definition Classes
    Action → AnyRef → Any
  43. val topic: String
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  47. def waitUntilRemainingTasksFinished: Unit

    extensions that process tasks in separate threads should override this and wait until those threads are done

    extensions that process tasks in separate threads should override this and wait until those threads are done

    Definition Classes
    Extension

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PrintAction

Inherited from ResponsiveAction

Inherited from Action

Inherited from MMTTask

Inherited from Killable

Inherited from Extension

Inherited from Logger

Inherited from AnyRef

Inherited from Any

Ungrouped