object BatStartScriptPlugin extends AutoPlugin with ApplicationIniGenerator with CommonStartScriptGenerator

Bat StartScript Plugin

This plugins creates a start bat script to run an application built with the com.typesafe.sbt.packager.archetypes.JavaAppPackaging.

Linear Supertypes
CommonStartScriptGenerator, ApplicationIniGenerator, AutoPlugin, PluginsFunctions, Basic, Plugins, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BatStartScriptPlugin
  2. CommonStartScriptGenerator
  3. ApplicationIniGenerator
  4. AutoPlugin
  5. PluginsFunctions
  6. Basic
  7. Plugins
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class BatScriptConfig(executableScriptName: String, scriptClasspath: Seq[String], configLocation: Option[String], extraDefines: Seq[String], replacements: Seq[(String, String)], templateLocation: File, bundledJvmLocation: Option[String]) extends ScriptConfig with Product with Serializable
    Attributes
    protected[this]
  2. type SpecializedScriptConfig = BatScriptConfig

    The type of specialized ScriptConfig.

    The type of specialized ScriptConfig. This enables callback methods of the concrete plugin implementations to use fields of config that only exist in their ScriptConfig specialization.

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  3. trait ScriptConfig extends AnyRef
    Attributes
    protected[this]
    Definition Classes
    CommonStartScriptGenerator

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def &&(o: Basic): Plugins
    Definition Classes
    Basic → Plugins
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def allRequirements: PluginTrigger
    Definition Classes
    PluginsFunctions
  6. val appIniLocation: String

    Location for the application.ini file used by the bat script to load initialization parameters for jvm and app

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val batTemplate: String

    Name of the bat template if user wants to provide custom one

  9. def buildSettings: Seq[sbt.Def.Setting[_]]
    Definition Classes
    AutoPlugin
  10. def cleanApplicationIniPath(path: String): String

    path

    that could be relative to APP_HOME

    returns

    path relative to APP_HOME

    Attributes
    protected
    Definition Classes
    BatStartScriptPlugin → ApplicationIniGenerator
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def createReplacementsForMainScript(mainClass: String, mainClasses: Seq[String], config: SpecializedScriptConfig): Seq[(String, String)]
    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  13. def derivedProjects(proj: ProjectDefinition[_]): Seq[Project]
    Definition Classes
    AutoPlugin
  14. def empty: Plugins
    Definition Classes
    PluginsFunctions
  15. val eol: String

    Line separator for generated scripts

    Line separator for generated scripts

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. val executableBitValue: Boolean

    Set executable bit of the generated scripts to this value

    Set executable bit of the generated scripts to this value

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
    To do

    Does it work when building archives on hosts that do not support such permission?

  19. def extraProjects: Seq[Project]
    Definition Classes
    AutoPlugin
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. val forwarderTemplateName: String

    Name of the bat forwarder template if user wants to provide custom one

    Name of the bat forwarder template if user wants to provide custom one

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  22. def generateApplicationIni(universalMappings: Seq[(File, String)], javaOptions: Seq[String], bashScriptConfigLocation: Option[String], tmpDir: File, log: sbt.Logger): Seq[(File, String)]

    returns

    the existing mappings plus a generated application.ini if custom javaOptions are specified

    Definition Classes
    ApplicationIniGenerator
  23. def generateStartScripts(config: SpecializedScriptConfig, mainClass: Option[String], discoveredMainClasses: Seq[String], targetDir: File, log: sbt.Logger): Seq[(File, String)]
    Attributes
    protected[this]
    Definition Classes
    CommonStartScriptGenerator
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def globalSettings: Seq[sbt.Def.Setting[_]]
    Definition Classes
    AutoPlugin
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. val keySurround: (String) ⇒ String

    keySurround for TemplateWriter.generateScript()

    keySurround for TemplateWriter.generateScript()

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  29. val label: String
    Definition Classes
    AutoPlugin
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTrigger: PluginTrigger
    Definition Classes
    PluginsFunctions
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def projectConfigurations: Seq[Configuration]
    Definition Classes
    AutoPlugin
  35. def projectSettings: Seq[sbt.Setting[_]]
    Definition Classes
    BatStartScriptPlugin → AutoPlugin
  36. val requires: JavaAppPackaging.type
    Definition Classes
    BatStartScriptPlugin → AutoPlugin
  37. val scriptSuffix: String

    Suffix to append to the generated script name (such as ".bat")

    Suffix to append to the generated script name (such as ".bat")

    Attributes
    protected[this]
    Definition Classes
    BatStartScriptPlugin → CommonStartScriptGenerator
  38. val scriptTargetFolder: String

    Script destination in final package

    Script destination in final package

    Attributes
    protected[this]
    Definition Classes
    CommonStartScriptGenerator
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AutoPlugin → AnyRef → Any
  41. val trigger: AllRequirements.type
    Definition Classes
    BatStartScriptPlugin → AutoPlugin
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. object BatScriptConfig extends AbstractFunction6[String, Seq[String], Option[String], Seq[String], Seq[(String, String)], File, BatScriptConfig] with Serializable
  46. object Defines

    Bat defines

  47. object Replacements

    Bat script replacements

  48. object autoImport extends BatStartScriptKeys

Inherited from CommonStartScriptGenerator

Inherited from ApplicationIniGenerator

Inherited from AutoPlugin

Inherited from PluginsFunctions

Inherited from Basic

Inherited from Plugins

Inherited from AnyRef

Inherited from Any

Ungrouped