Trait

nl.biopet.utils.tool.multi

MultiToolCommand

Related Doc: package multi

Permalink

trait MultiToolCommand extends ToolCommand[Args]

Linear Supertypes
ToolCommand[Args], Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MultiToolCommand
  2. ToolCommand
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def descriptionText: String

    Permalink

    Force description to be written for each tool.

    Force description to be written for each tool.

    Definition Classes
    ToolCommand
  2. abstract def exampleText: String

    Permalink

    Force an example to be written for each tool

    Force an example to be written for each tool

    Definition Classes
    ToolCommand
  3. abstract def manualText: String

    Permalink

    Force a manual to be written for each tool

    Force a manual to be written for each tool

    Definition Classes
    ToolCommand
  4. abstract def subTools: Map[String, List[ToolCommand[_]]]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aboutText: String

    Permalink

    Universal text referring to BIOPET.

    Universal text referring to BIOPET.

    Definition Classes
    ToolCommand
  5. def allTools: List[ToolCommand[_]]

    Permalink
  6. def argsParser: ArgsParser

    Permalink

    This is the parser object that will be tested.

    This is the parser object that will be tested.

    Definition Classes
    MultiToolCommandToolCommand
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def cmdArrayToArgs(args: Array[String]): Args

    Permalink

    Converts args to a Args case class

    Converts args to a Args case class

    Definition Classes
    ToolCommand
  10. def contactText: String

    Permalink

    Universal contact text

    Universal contact text

    Definition Classes
    ToolCommand
  11. def contributingText: String

    Permalink

    Universal contributing text

    Universal contributing text

    Definition Classes
    ToolCommand
  12. def documentationText: String

    Permalink

    Universal text for pointing to the documentation.

    Universal text for pointing to the documentation.

    Definition Classes
    ToolCommand
  13. def emptyArgs: Args

    Permalink

    Returns an empty/default args case class

    Returns an empty/default args case class

    Definition Classes
    MultiToolCommandToolCommand
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def example(args: String*): String

    Permalink

    Convert and tests args

    Convert and tests args

    Definition Classes
    ToolCommand
  17. def extendedDescriptionText: String

    Permalink
  18. def extendedExampleText: String

    Permalink
  19. def extendedManualText: String

    Permalink
  20. def extendedUsage: Boolean

    Permalink
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def generateDocumentation(outputDirectory: File, version: String, release: Boolean = false): Unit

    Permalink

    Outputs markdown documentation for LAIKA processing.

    Outputs markdown documentation for LAIKA processing.

    outputDirectory

    outputs the Markdown documentation in this directory

    Definition Classes
    ToolCommand
  23. def generateReadme(outputFile: File): Unit

    Permalink

    Generates the README

    Generates the README

    outputFile

    The readme file

    Definition Classes
    ToolCommand
  24. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def installationText: String

    Permalink

    Universal installation text

    Universal installation text

    Definition Classes
    ToolCommand
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def logger: Logger

    Permalink
    Definition Classes
    Logging
  29. def main(args: Array[String]): Unit

    Permalink

    This is the main entry point of the tool

    This is the main entry point of the tool

    Definition Classes
    MultiToolCommandToolCommand
  30. def mainPageContents: List[(String, String)]

    Permalink

    Which chapters should be on the tool documentation's main page

    Which chapters should be on the tool documentation's main page

    Definition Classes
    ToolCommand
  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. def printToolList(title: String, tools: List[ToolCommand[_]]): Unit

    Permalink
  35. def printToolList(): Unit

    Permalink
  36. def readmeContents: List[(String, String)]

    Permalink

    Which chapters should be in the README

    Which chapters should be in the README

    Definition Classes
    ToolCommand
  37. def singleTool(name: String): ToolCommand[_]

    Permalink
  38. def sparkExample(args: String*): String

    Permalink

    Convert and tests args

    Convert and tests args

    Definition Classes
    ToolCommand
  39. def sparkUnsafeExample(args: String*): String

    Permalink

    Convert and *not* tests args

    Convert and *not* tests args

    Definition Classes
    ToolCommand
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  41. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  42. def toolName: String

    Permalink

    This will return the name of the tool

    This will return the name of the tool

    Definition Classes
    ToolCommand
  43. def unsafeExample(args: String*): String

    Permalink

    Convert and *not* tests args

    Convert and *not* tests args

    Definition Classes
    ToolCommand
  44. def urlToolName: String

    Permalink

    This is the tool name to be used in URL.

    This is the tool name to be used in URL. Can be overwritten.

    Definition Classes
    ToolCommand
  45. def usageHeaders: List[String]

    Permalink
    Attributes
    protected
    Definition Classes
    ToolCommand
  46. def usageHtmlTable: String

    Permalink
    Definition Classes
    ToolCommand
  47. def usageRows(parser: OptionParser[Args]): List[List[String]]

    Permalink
    Attributes
    protected
    Definition Classes
    ToolCommand
  48. def usageText: String

    Permalink

    Creates a html formatted usage string

    Creates a html formatted usage string

    Definition Classes
    MultiToolCommandToolCommand
  49. def validateArgs(args: String*): Unit

    Permalink
    Definition Classes
    MultiToolCommandToolCommand
  50. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ToolCommand[Args]

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped