t

mill.scalalib

JavaModule

trait JavaModule extends Module with TaskModule with GenIdeaModule with CoursierModule with OfflineSupportModule

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaModule
  2. OfflineSupportModule
  3. CoursierModule
  4. GenIdeaModule
  5. TaskModule
  6. Module
  7. Cacher
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait JavaModuleTests extends Module with TestModule
  2. trait Tests extends Module with JavaModuleTests

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 allSourceFiles: Target[Seq[api.PathRef]]

    All individual source files fed into the Java compiler

  5. def allSources: Target[Seq[eval.PathRef]]

    The folders containing all source files fed into the compiler

  6. def artifactId: T[String]

    The exact id of the artifact to be published.

    The exact id of the artifact to be published. You probably don't want to override this. If you want to customize the name of the artifact, override artifactName instead. If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion

  7. def artifactName: T[String]

    Override this to change the published artifact id.

    Override this to change the published artifact id. For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz. Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def assembly: Target[eval.PathRef]

    An executable uber-jar/assembly containing all the resources and compiled classfiles from this module and all it's upstream modules and dependencies

  10. def assemblyRules: Seq[Rule]
  11. def cachedTarget[T](t: => T)(implicit c: Enclosing): T
    Attributes
    protected[this]
    Definition Classes
    Cacher
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def compile: T[CompilationResult]

    Compiles the current module to generate compiled classfiles/bytecode

  14. def compileClasspath: Target[api.Loose.Agg[eval.PathRef]]

    All classfiles and resources from upstream modules and dependencies necessary to compile this module

  15. def compileIvyDeps: Target[api.Loose.Agg[Dep]]

    Same as ivyDeps, but only present at compile time.

    Same as ivyDeps, but only present at compile time. Useful for e.g. macro-related dependencies like scala-reflect that doesn't need to be present at runtime

  16. def compileModuleDeps: Seq[JavaModule]

    The compile-only direct dependencies of this module.

  17. def defaultCommandName(): String
    Definition Classes
    JavaModule → TaskModule
  18. def docJar: Target[eval.PathRef]

    The documentation jar, containing all the Javadoc/Scaladoc HTML files, for publishing to Maven Central

  19. def docSources: Sources

    Extra directories to be processed by the API documentation tool.

    Extra directories to be processed by the API documentation tool.

    Typically includes static files such as html and markdown, but depends on the doc tool that is actually used.

  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def finalMainClass: T[String]
  23. def finalMainClassOpt: T[Either[String, String]]
  24. def forkArgs: Target[Seq[String]]

    Any command-line parameters you want to pass to the forked JVM under run, test or repl

  25. def forkEnv: Target[Map[String, String]]

    Any environment variables you want to pass to the forked JVM under run, test or repl

  26. def forkWorkingDir: Target[Path]
  27. def generatedSources: Target[Seq[eval.PathRef]]

    Folders containing source files that are generated rather than hand-written; these files can be generated in this target itself, or can refer to files generated from other targets

  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def ideaCompileOutput: T[PathRef]
    Definition Classes
    GenIdeaModule
  31. def ideaConfigFiles(ideaConfigVersion: Int): Command[Seq[IdeaConfigFile]]

    Contribute components to idea config files.

    Contribute components to idea config files.

    Definition Classes
    GenIdeaModule
  32. def ideaJavaModuleFacets(ideaConfigVersion: Int): Command[Seq[JavaFacet]]

    Contribute facets to the Java module configuration.

    Contribute facets to the Java module configuration.

    ideaConfigVersion

    The IDEA configuration version in use. Probably 4.

    Definition Classes
    GenIdeaModule
  33. def intellijModulePath: Path
    Definition Classes
    GenIdeaModule
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def ivyDeps: Target[api.Loose.Agg[Dep]]

    Any ivy dependencies you want to add to this Module, in the format ivy"org::name:version" for Scala dependencies or ivy"org:name:version" for Java dependencies

  36. def ivyDepsTree(inverse: Boolean = false, withCompile: Boolean = false, withRuntime: Boolean = false): Command[Unit]

    Command to print the transitive dependency tree to STDOUT.

    Command to print the transitive dependency tree to STDOUT.

    inverse

    Invert the tree representation, so that the root is on the bottom.

    withCompile

    Include the compile-time only dependencies (compileIvyDeps, provided scope) into the tree.

    withRuntime

    Include the runtime dependencies (runIvyDeps, runtime scope) into the tree.

  37. def jar: Target[eval.PathRef]

    A jar containing only this module's resources and compiled classfiles, without those from upstream modules and dependencies

  38. def javacOptions: Target[Seq[String]]

    Options to pass to the java compiler

  39. def javadocOptions: T[Seq[String]]

    Additional options to be used by the javadoc tool.

    Additional options to be used by the javadoc tool. You should not set the -d setting for specifying the target directory, as that is done in the docJar target.

  40. def launcher: Target[api.PathRef]

    Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process.

    Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process. Useful for deployment & other places where you do not want a build tool running

  41. def localClasspath: Target[Seq[eval.PathRef]]

    The output classfiles/resources from this module, excluding upstream modules and third-party dependencies

  42. def mainClass: T[Option[String]]

    Allows you to specify an explicit main class to use for the run command.

    Allows you to specify an explicit main class to use for the run command. If none is specified, the classpath is searched for an appropriate main class to use if one exists

  43. def manifest: T[JarManifest]

    Creates a manifest representation which can be modifed or replaced The default implementation just adds the Manifest-Version, Main-Class and Created-By attributes

  44. def mapDependencies: Task[(Dependency) => Dependency]

    Map dependencies before resolving them.

    Map dependencies before resolving them. Override this to customize the set of dependencies.

    Definition Classes
    CoursierModule
  45. implicit def millModuleBasePath: BasePath
    Definition Classes
    Module
  46. lazy val millModuleDirectChildren: Seq[define.Module]
    Definition Classes
    Module
  47. implicit def millModuleExternal: External
    Definition Classes
    Module
  48. implicit def millModuleSegments: Segments
    Definition Classes
    Module
  49. implicit def millModuleShared: Foreign
    Definition Classes
    Module
  50. def millOuterCtx: Ctx
    Definition Classes
    Module
  51. def millSourcePath: Path
    Definition Classes
    Module
  52. def moduleDeps: Seq[JavaModule]

    The direct dependencies of this module

  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  56. def platformSuffix: T[String]

    What platform suffix to use for publishing, e.g.

    What platform suffix to use for publishing, e.g. _sjs for Scala.js projects

  57. def prepareOffline(): Command[Unit]

    Prepare the module for working offline.

    Prepare the module for working offline. This should typically fetch (missing) resources like ivy dependencies.

    Definition Classes
    JavaModule → OfflineSupportModule
  58. def prependShellScript: T[String]

    What shell script to use to launch the executable generated by assembly.

    What shell script to use to launch the executable generated by assembly. Defaults to a generic "universal" launcher that should work for Windows, OS-X and Linux

  59. def printDepsTree(inverse: Boolean, additionalDeps: Task[api.Loose.Agg[Dep]]): Task[Unit]

    Task that print the transitive dependency tree to STDOUT.

    Task that print the transitive dependency tree to STDOUT.

    inverse

    Invert the tree representation, so that the root is on the bottom.

    additionalDeps

    Additional dependency to be included into the tree.

    Attributes
    protected
  60. def recursiveModuleDeps: Seq[JavaModule]

    The direct and indirect dependencies of this module

  61. def repositoriesTask: Task[Seq[Repository]]

    The repositories used to resolved dependencies with resolveDeps().

    The repositories used to resolved dependencies with resolveDeps().

    Definition Classes
    CoursierModule
  62. def resolveCoursierDependency: Task[(Dep) => Dependency]
    Definition Classes
    CoursierModule
  63. def resolveDeps(deps: Task[Agg[Dep]], sources: Boolean = false): Task[Agg[eval.PathRef]]

    Task that resolves the given dependencies using the repositories defined with repositories.

    Task that resolves the given dependencies using the repositories defined with repositories.

    deps

    The dependencies to resolve.

    sources

    If true, resolve source dependencies instead of binary dependencies (JARs).

    returns

    The PathRefs to the resolved files.

    Definition Classes
    CoursierModule
  64. def resolvePublishDependency: Task[(Dep) => Dependency]
  65. def resolvedIvyDeps: T[api.Loose.Agg[eval.PathRef]]
  66. def resolvedRunIvyDeps: T[api.Loose.Agg[eval.PathRef]]
  67. def resources: Sources

    The folders where the resource files for this module live

  68. def run(args: String*): Command[Unit]

    Runs this module's code in a subprocess and waits for it to finish

  69. def runBackground(args: String*): Command[Unit]

    Runs this module's code in a background process, until it dies or runBackground is used again.

    Runs this module's code in a background process, until it dies or runBackground is used again. This lets you continue using Mill while the process is running in the background: editing files, compiling, and only re-starting the background process when you're ready.

    You can also use -w foo.runBackground to make Mill watch for changes and automatically recompile your code & restart the background process when ready. This is useful when working on long-running server processes that would otherwise run forever

  70. def runClasspath: Target[Seq[eval.PathRef]]

    All classfiles and resources from upstream modules and dependencies necessary to run this module's code after compilation

  71. def runIvyDeps: Target[api.Loose.Agg[Dep]]

    Same as ivyDeps, but only present at runtime.

    Same as ivyDeps, but only present at runtime. Useful for e.g. selecting different versions of a dependency to use at runtime after your code has already been compiled

  72. def runLocal(args: String*): Command[Unit]

    Runs this module's code in-process within an isolated classloader.

    Runs this module's code in-process within an isolated classloader. This is faster than run, but in exchange you have less isolation between runs since the code can dirty the parent Mill process and potentially leave it in a bad state.

  73. def runMain(mainClass: String, args: String*): Command[Unit]

    Same as run, but lets you specify a main class to run

  74. def runMainBackground(mainClass: String, args: String*): Command[Unit]

    Same as runBackground, but lets you specify a main class to run

  75. def runMainLocal(mainClass: String, args: String*): Command[Unit]

    Same as runLocal, but lets you specify a main class to run

  76. def showModuleDeps(recursive: Boolean = false): Command[Unit]

    Show the module dependencies.

    Show the module dependencies.

    recursive

    If true include all recursive module dependencies, else only show direct dependencies.

  77. def skipIdea: Boolean

    Skip Idea project file generation.

    Skip Idea project file generation.

    Definition Classes
    GenIdeaModule
  78. def sourceJar: Target[eval.PathRef]

    The source jar, containing only source code for publishing to Maven Central

  79. def sources: Sources

    The folders where the source files for this module live

  80. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  81. def toString(): String
    Definition Classes
    Module → AnyRef → Any
  82. def transitiveCompileIvyDeps: T[api.Loose.Agg[Dep]]

    The compile-only transitive ivy dependencies of this module and all it's upstream compile-only modules.

  83. def transitiveIvyDeps: T[api.Loose.Agg[Dep]]

    The transitive ivy dependencies of this module and all it's upstream modules

  84. def transitiveLocalClasspath: T[api.Loose.Agg[eval.PathRef]]

    The transitive version of localClasspath

  85. def transitiveModuleDeps: Seq[JavaModule]

    Like recursiveModuleDeps but also include the module itself

  86. def unmanagedClasspath: Target[api.Loose.Agg[eval.PathRef]]

    Additional jars, classfiles or resources to add to the classpath directly from disk rather than being downloaded from Maven Central or other package repositories

  87. def upstreamAssembly: Target[eval.PathRef]

    Build the assembly for upstream dependencies separate from the current classpath

    Build the assembly for upstream dependencies separate from the current classpath

    This should allow much faster assembly creation in the common case where upstream dependencies do not change

  88. def upstreamAssemblyClasspath: Target[api.Loose.Agg[eval.PathRef]]

    All upstream classfiles and resources necessary to build and executable assembly, but without this module's contribution

  89. def upstreamCompileOutput: Target[Seq[CompilationResult]]

    The upstream compilation output of all this module's upstream modules

  90. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  91. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  93. def zincWorker: ZincWorkerModule
  94. object millInternal extends Internal
    Definition Classes
    Module
    Annotations
    @Scaladoc()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def repositories: Seq[Repository]

    The repositories used to resolved dependencies with resolveDeps().

    The repositories used to resolved dependencies with resolveDeps().

    Definition Classes
    CoursierModule
    Annotations
    @deprecated
    Deprecated

    (Since version after mill 0.8.0) Use repositoriesTask instead

Inherited from OfflineSupportModule

Inherited from CoursierModule

Inherited from GenIdeaModule

Inherited from TaskModule

Inherited from define.Module

Inherited from Cacher

Inherited from AnyRef

Inherited from Any

Ungrouped