Index

A B C D E F H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

and(String...) - Method in class org.copalis.jam.util.Args: Adds supplied arguments and returns the current list
andAll(Args) - Method in class org.copalis.jam.util.Args: Adds another args list to this
Args - Class in org.copalis.jam.util: A utility class for constructing vararg parameter lists.
array() - Method in class org.copalis.jam.util.Args: Returns the arguments as an array

B

BuildContext - Record Class in org.copalis.jam.cli: Represents the build state
BuildContext(Memorizer, File) - Constructor for record class org.copalis.jam.cli.BuildContext: Creates an instance of a BuildContext record class.
BuildController<T> - Class in org.copalis.jam.cli: A build process command-line argument parser and controller.
BuildController(Class<T>) - Constructor for class org.copalis.jam.cli.BuildController: Creates a build controller instance
buildPath() - Method in interface FileProject: Gets the root directory for the project's build artifacts.
buildPath(String) - Method in interface FileProject: Generates the path of a build directory and creates the directory if it does not exist
builtFiles(String) - Method in interface FileProject: Gets a fileset referencing built files

C

cacheDir() - Method in record class org.copalis.jam.util.IvyResolver: Returns the value of the cacheDir record component.
Cache eligibility - Search tag in class org.copalis.jam.memo.Memorizer: Section
cacheFile() - Method in record class org.copalis.jam.cli.BuildContext: Returns the value of the cacheFile record component.
CHANGED - Static variable in interface org.copalis.jam.memo.Mutable: A Mutable instance that always returns true from Mutable.modified()
classpath(Fileset...) - Method in interface JavaProject: Generates a classpath string suitable for the java compiler
clean() - Method in interface FileProject: Deletes the build directory specified by FileProject.buildPath().
clean() - Method in interface Project: The clean build target.
cleanPkgCache() - Method in interface JavaProject: Deletes the package resolver's cache
compile(Iterable<? extends File>, Iterable<String>) - Static method in class org.copalis.jam.util.Compiler: Compiles Java source files
Compiler - Class in org.copalis.jam.util: Java build utilities
COMPUTE - Enum constant in enum class org.copalis.jam.memo.Observer.Status: The method must be executed as there is no cached result for the invocation
context() - Method in interface Project: Gets the current build context
CURRENT - Enum constant in enum class org.copalis.jam.memo.Observer.Status: The cache contains a fresh result for the method invocation
currently(T) - Method in interface Project: Wraps a value in a non-serializable Supplier.

D

dependencies() - Method in record class org.copalis.jam.memo.Result: Returns the value of the dependencies record component.
digest(String) - Method in class File: Generates a digest of the file's contents
dokka(String, String...) - Method in interface KotlinProject: Generates Dokka documentation for Kotlin (and Java) sources.
download(File, File) - Method in record class org.copalis.jam.util.IvyResolver: Executes Ivy
download(Path, String) - Static method in class org.copalis.jam.util.Paths: Downloads a resource

E

endMethod(Observer.Status, Method, List<Object>, Object) - Method in interface org.copalis.jam.memo.Observer: Notification that a method has completed
entries() - Method in class org.copalis.jam.memo.Memorizer: Gets the cache contents
equals(Object) - Method in class File
equals(Object) - Method in class Fileset
equals(Object) - Method in record class org.copalis.jam.cli.BuildContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.copalis.jam.memo.Invocation: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.copalis.jam.memo.Result: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.copalis.jam.util.IvyResolver: Indicates whether some other object is "equal to" this one.
exec(ProcessBuilder, String...) - Method in interface FileProject: Executes an external process using a supplied ProcessBuilder
exec(String...) - Method in interface FileProject: Executes an external process
executeBuild(Consumer<T>, String[]) - Method in class org.copalis.jam.cli.BuildController: Executes a build as specified by command-line arguments.

F

file(String) - Method in class Fileset: Gets a file from this fileset
File - Class in Unnamed Package: A reference to an existing file
File(String) - Constructor for class File: Creates a reference to a file specified by a path string
File(URI) - Constructor for class File: Creates a reference to a file specified by a URI
File(Path) - Constructor for class File: Creates a reference to a file specified by a Path object
FileProject - Interface in Unnamed Package: Extends Project with common functionality for creating build artifacts derived from source files.
Fileset - Class in Unnamed Package: A reference to a set of existing files
Fileset(Set<File>, String, String) - Constructor for class Fileset: Constructs a Fileset
find(String) - Static method in class Fileset: Creates a Fileset containing all files that match a selection string
find(String, String) - Static method in class Fileset: Creates a Fileset containing all files that match a selection string
forget() - Method in class org.copalis.jam.memo.Memorizer: Erases all method call results from the cache
fromURI(URI) - Static method in class org.copalis.jam.util.Paths: Converts a URI to a Path relative to the working directory

H

hasChanged(Object) - Static method in interface org.copalis.jam.memo.Mutable: Checks if an object is a reference to a resource that has been modified
hashCode() - Method in class Fileset
hashCode() - Method in record class org.copalis.jam.cli.BuildContext: Returns a hash code value for this object.
hashCode() - Method in record class org.copalis.jam.memo.Invocation: Returns a hash code value for this object.
hashCode() - Method in record class org.copalis.jam.memo.Result: Returns a hash code value for this object.
hashCode() - Method in record class org.copalis.jam.util.IvyResolver: Returns a hash code value for this object.

I

Incremental builds - Search tag in class org.copalis.jam.cli.BuildController: Section
instantiate(Class<T>) - Method in class org.copalis.jam.memo.Memorizer: Creates a memoized instance of an interface.
Invocation - Record Class in org.copalis.jam.memo: The signature of a method call
Invocation(Method, Object...) - Constructor for record class org.copalis.jam.memo.Invocation: Creates an instance
Invocation(String, List<Object>) - Constructor for record class org.copalis.jam.memo.Invocation: Creates an instance of a Invocation record class.
iterator() - Method in class Fileset
ivyJar() - Method in record class org.copalis.jam.util.IvyResolver: Gets a reference to a local copy of the Ivy jar file
IvyResolver - Record Class in org.copalis.jam.util: A wrapper for the Apache Ivy dependency manager
IvyResolver(String, String, File) - Constructor for record class org.copalis.jam.util.IvyResolver: Creates an instance of a IvyResolver record class.

J

jar(String, Fileset...) - Method in interface JavaProject: Creates a .jar archive
java(String...) - Method in interface JavaProject: Runs a Java process.
javac(String, Fileset, String...) - Method in interface JavaProject: Compiles Java code.
javadoc(String...) - Static method in class org.copalis.jam.util.Compiler: Generates JavaDoc
javadoc(String, String...) - Method in interface JavaProject: Runs the JavaDoc tool
JavaProject - Interface in Unnamed Package: Extends @link FileProject} with functionality for building Java applications and libraries.
junit(String, String...) - Method in interface JavaProject: Runs unit tests using the jUnit console library specified by JavaProject.jUnitLib()
jUnitLib() - Method in interface JavaProject: Specifies the jUnit console and runtime libraries.

K

kotlin(String...) - Method in interface KotlinProject: Runs a Kotlin program.
kotlinc(String, Fileset, String...) - Method in interface KotlinProject: Compiles Kotlin code.
kotlincJar(String, Fileset, String...) - Method in interface KotlinProject: Compiles Kotlin code directly to a self-contained .jar archive, bundling the Kotlin runtime with -include-runtime.
kotlincJava(String, Fileset, Fileset, String...) - Method in interface KotlinProject: Compiles mixed Kotlin and Java sources.
KotlinProject - Interface in Unnamed Package: Extends JavaProject with functionality for building Kotlin applications and libraries.

L

load(InputStream) - Method in class org.copalis.jam.memo.Memorizer: Loads the cache
lookup(Invocation) - Method in class org.copalis.jam.memo.Memorizer: Looks up a cache entry

M

memoizer() - Method in record class org.copalis.jam.cli.BuildContext: Returns the value of the memoizer record component.
Memorizer - Class in org.copalis.jam.memo: A method memoizer that can also determine when methods need to be re-executed as a result of changes to external resources.
Memorizer() - Constructor for class org.copalis.jam.memo.Memorizer: Creates an instance with no related observer or cache file
Memorizer(Observer) - Constructor for class org.copalis.jam.memo.Memorizer: Creates an instance
modified() - Method in class File
modified() - Method in class Fileset
modified() - Method in record class org.copalis.jam.memo.Invocation
modified() - Method in interface org.copalis.jam.memo.Mutable: Checks if the resource has been modified since this reference was created
modified() - Method in record class org.copalis.jam.memo.Result
Mutable - Interface in org.copalis.jam.memo: A reference to one or more resources that might have been modified since the reference was created

N

name() - Method in record class org.copalis.jam.memo.Invocation: Returns the value of the name record component.

O

Observer - Interface in org.copalis.jam.memo: A method invocation observer that is allowed to modify return values
Observer.Status - Enum Class in org.copalis.jam.memo: Represents the cache status for a method invocation
of(File...) - Static method in class Fileset: Creates a Fileset from an array of File objects
of(String...) - Static method in class org.copalis.jam.util.Args: Creates a new list with the supplied arguments
of(Set<File>) - Static method in class Fileset: Creates a Fileset from a set of File objects
of(Stream<Path>) - Static method in class Fileset: Creates a Fileset from a stream of paths
org.copalis.jam.cli - package org.copalis.jam.cli: Jam build automation, including command-line parameter handling.
org.copalis.jam.memo - package org.copalis.jam.memo: The core Jam classes used for memoization and build automation, including handling command-line parameters.
org.copalis.jam.util - package org.copalis.jam.util

P

packageResolver() - Method in interface JavaProject: Gets the package dependency resolver.
PackageResolver - Interface in org.copalis.jam.util: A package dependency resolver which fetches packages from a repository
params() - Method in record class org.copalis.jam.memo.Invocation: Returns the value of the params record component.
pathElements() - Method in class Fileset: Gets a stream of contents
Paths - Class in org.copalis.jam.util: Utility methods for paths
pkgCachePath() - Method in interface JavaProject: Gets the location of the package cache
Project - Interface in Unnamed Package: The base Project interface which defines the clean build target and provides functionality to track source file dependencies, control the build process and handle command-line options.

R

read(String) - Method in interface FileProject: Reads the contents of a text source file
REFERENCE - Static variable in record class org.copalis.jam.cli.BuildContext: A sentinel object that, when used as the return value of a proxied method, will be replaced by BuildController method interceptor with an instance that references the real cache state
REFRESH - Enum constant in enum class org.copalis.jam.memo.Observer.Status: The method must be executed because the cached result is stale
relativize(Path) - Static method in class org.copalis.jam.util.Paths: Relativizes a path with respect to the current working directory
resolve(String...) - Method in interface JavaProject: Gets dependencies
resolve(String...) - Method in record class org.copalis.jam.util.IvyResolver
resolve(String...) - Method in interface org.copalis.jam.util.PackageResolver: Resolves dependencies
Result - Record Class in org.copalis.jam.memo: The result of a method call
Result(Invocation, Object, Set<Mutable>) - Constructor for record class org.copalis.jam.memo.Result: Creates an instance of a Result record class.
rmdir(String) - Method in interface FileProject: Deletes a directory, which must be the build directory or one of its children
rmDir(Path) - Static method in class org.copalis.jam.util.Paths: Deletes a directory
rootPath() - Method in class Fileset: Gets the base path of the files in this set, if there is one
run() - Method in class org.copalis.jam.util.Args: Executes an external process using these arguments
run(Class<T>, Consumer<T>, String[]) - Static method in interface Project: Executes a project using BuildController.executeBuild(Consumer, String[])
run(ProcessBuilder) - Method in class org.copalis.jam.util.Args: Executes an external process using these arguments

S

save(OutputStream) - Method in class org.copalis.jam.memo.Memorizer: Writes the contents of the method call cache to an output stream, excluding method calls which are not serializable.
settingsFile() - Method in record class org.copalis.jam.util.IvyResolver: Returns the value of the settingsFile record component.
signature() - Method in record class org.copalis.jam.memo.Result: Returns the value of the signature record component.
size() - Method in class Fileset: Gets the number of files in this set
sourceFile(String) - Method in interface FileProject: Gets a file with a specific path.
sourceFiles(String) - Method in interface FileProject: Gets source files matching a pattern.
sourcePath() - Method in interface FileProject: Gets the root directory for the project's source code.
Staleness checking - Search tag in class org.copalis.jam.memo.Memorizer: Section
startMethod(Observer.Status, Method, List<Object>) - Method in interface org.copalis.jam.memo.Observer: Notification that a method is about to be invoked
stream() - Method in class Fileset: Streams the files in this set

T

Targets - Search tag in class org.copalis.jam.cli.BuildController: Section
toString() - Method in class Fileset
toString() - Method in record class org.copalis.jam.cli.BuildContext: Returns a string representation of this record class.
toString() - Method in record class org.copalis.jam.memo.Invocation: Returns a string representation of this record class.
toString() - Method in record class org.copalis.jam.memo.Result: Returns a string representation of this record class.
toString() - Method in class org.copalis.jam.util.Args
toString() - Method in record class org.copalis.jam.util.IvyResolver: Returns a string representation of this record class.

U

<Unnamed> - package <Unnamed>: Jam Project interfaces and reference types.
url() - Method in record class org.copalis.jam.util.IvyResolver: Returns the value of the url record component.

V

value() - Method in record class org.copalis.jam.memo.Result: Returns the value of the value record component.
valueOf(String) - Static method in enum class org.copalis.jam.memo.Observer.Status: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.copalis.jam.memo.Observer.Status: Returns an array containing the constants of this enum class, in the order they are declared.
VER2_5_1_URL - Static variable in record class org.copalis.jam.util.IvyResolver: The default URL of the Ivy runtime jar

W

write(String, String) - Method in interface FileProject: Creates a file and writes content to it

A B C D E F H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form