A B C D E F G I J L M N P R S T U V X

A

addToComponent(String, File[]) - Method in interface xsbti.ComponentProvider

Modify an existing component by adding files to it.

app(ApplicationID, String) - Method in interface xsbti.Launcher

returns an `AppProvider` which is able to resolve an application and instantiate its `xsbti.Main` in a new classloader.

app() - Method in interface xsbti.Reboot

app(ApplicationID) - Method in interface xsbti.ScalaProvider

Creates an application provider that will use 'loader()' as the parent ClassLoader for the application given by 'id'.

AppConfiguration - Interface in xsbti

ApplicationID - Interface in xsbti

This represents an identification for the sbt launcher to load and run an sbt launched application using ivy.

apply(File, Callable<T>) - Method in interface xsbti.GlobalLock

AppMain - Interface in xsbti

The main entry interface for launching applications.

AppProvider - Interface in xsbti

This represents an interface that can generate applications or servers.

appRepositories() - Method in interface xsbti.Launcher

These are the repositories configured by this launcher which should be used by the application when resolving further artifacts.

arguments() - Method in interface xsbti.AppConfiguration

arguments() - Method in exception xsbti.FullReload

arguments() - Method in interface xsbti.Reboot

artifactPattern() - Method in interface xsbti.IvyRepository

awaitTermination() - Method in interface xsbti.Server

This should block the calling thread until the server is shutdown.

B

baseDirectory() - Method in interface xsbti.AppConfiguration

baseDirectory() - Method in interface xsbti.Reboot

bootDirectory() - Method in interface xsbti.Launcher

Value of the `sbt.boot.dir` property, or the default boot configuration defined in `boot.directory`.

C

checksums() - Method in interface xsbti.Launcher

An array of the checksums that should be checked when retreiving artifacts.

classpathExtra() - Method in interface xsbti.ApplicationID

Files to add to the application classpath.

clean() - Method in exception xsbti.FullReload

code() - Method in interface xsbti.Exit

compilerJar() - Method in interface xsbti.ScalaProvider

Deprecated. Only `jars` can be reliably provided for modularized Scala. (Since 0.13.0)

component(String) - Method in interface xsbti.ComponentProvider

Grab the current component definition.

componentLocation(String) - Method in interface xsbti.ComponentProvider

ComponentProvider - Interface in xsbti

A service to locate, install and modify "Components".

components() - Method in interface xsbti.AppProvider

Returns a mechanism you can use to install/find/resolve components.

Continue - Interface in xsbti

A launched application returns an instance of this class in order to communicate to the launcher that the application's main thread is finished and the launcher's work is complete, but it should not exit.

CrossValue - Enum in xsbti

crossVersioned() - Method in interface xsbti.ApplicationID

Deprecated. This method is no longer used if the crossVersionedValue method is available.

crossVersionedValue() - Method in interface xsbti.ApplicationID

D

defineComponent(String, File[]) - Method in interface xsbti.ComponentProvider

This will define a new component using the files passed in.

descriptorOptional() - Method in interface xsbti.IvyRepository

E

entryPoint() - Method in interface xsbti.AppProvider

Loads the class for the entry point for the application given by 'id'.

Exit - Interface in xsbti

A launched application returns an instance of this class in order to communicate to the launcher that the application finished and the launcher should exit with the given exit code.

F

FullReload - Exception in xsbti

FullReload(String[]) - Constructor for exception xsbti.FullReload

FullReload(String[], boolean) - Constructor for exception xsbti.FullReload

G

getScala(String) - Method in interface xsbti.Launcher

getScala(String, String) - Method in interface xsbti.Launcher

getScala(String, String, String) - Method in interface xsbti.Launcher

GlobalLock - Interface in xsbti

globalLock() - Method in interface xsbti.Launcher

Return the global lock for interacting with the file system.

groupID() - Method in interface xsbti.ApplicationID

I

id() - Method in interface xsbti.AppProvider

The ID of the application that will be created by 'newMain' or 'mainClass'.

id() - Method in interface xsbti.IvyRepository

id() - Method in interface xsbti.MavenRepository

id() - Method in interface xsbti.PredefinedRepository

InterfaceVersion - Static variable in interface xsbti.Launcher

isOverrideRepositories() - Method in interface xsbti.Launcher

The user has configured the launcher with the only repositories it wants to use for this applciation.

ivyHome() - Method in interface xsbti.Launcher

The value of `ivy.ivy-home` of the boot properties file.

ivyPattern() - Method in interface xsbti.IvyRepository

ivyRepositories() - Method in interface xsbti.Launcher

Configured launcher repositories.

IvyRepository - Interface in xsbti

J

jars() - Method in interface xsbti.ScalaProvider

Returns the scala-library.jar and scala-compiler.jar for this version of Scala.

L

Launcher - Interface in xsbti

launcher() - Method in interface xsbti.ScalaProvider

libraryJar() - Method in interface xsbti.ScalaProvider

Deprecated. Only `jars` can be reliably provided for modularized Scala. (Since 0.13.0)

loader() - Method in interface xsbti.AppProvider

The classloader used to load this application.

loader() - Method in interface xsbti.ScalaProvider

A ClassLoader that loads the classes from scala-library.jar and scala-compiler.jar.

lockFile() - Method in interface xsbti.ComponentProvider

M

mainClass() - Method in interface xsbti.ApplicationID

mainClass() - Method in interface xsbti.AppProvider

Deprecated.

mainClasspath() - Method in interface xsbti.AppProvider

The classpath from which the main class is loaded, excluding Scala jars.

mainComponents() - Method in interface xsbti.ApplicationID

MainResult - Interface in xsbti

A launched application should return an instance of this from its 'run' method to communicate to the launcher what should be done now that the application has completed.

mavenCompatible() - Method in interface xsbti.IvyRepository

MavenRepository - Interface in xsbti

N

name() - Method in interface xsbti.ApplicationID

newMain() - Method in interface xsbti.AppProvider

Creates a new instance of the entry point of the application given by 'id'.

P

Predefined - Enum in xsbti

PredefinedRepository - Interface in xsbti

provider() - Method in interface xsbti.AppConfiguration

R

Reboot - Interface in xsbti

A launched application returns an instance of this class in order to communicate to the launcher that the application should be restarted.

Repository - Interface in xsbti

RetrieveException - Exception in xsbti

RetrieveException(String, String) - Constructor for exception xsbti.RetrieveException

run(AppConfiguration) - Method in interface xsbti.AppMain

Run the application and return the result.

S

scalaProvider() - Method in interface xsbti.AppProvider

Returns the ScalaProvider that this AppProvider will use.

ScalaProvider - Interface in xsbti

Provides access to the jars and classes for a particular version of Scala.

scalaVersion() - Method in interface xsbti.Reboot

Server - Interface in xsbti

A running server.

ServerMain - Interface in xsbti

The main entry point for a launched service.

skipConsistencyCheck() - Method in interface xsbti.IvyRepository

start(AppConfiguration) - Method in interface xsbti.ServerMain

This method should launch one or more thread(s) which run the service.

T

topLoader() - Method in interface xsbti.Launcher

This returns the "top" classloader for a launched application.

toString() - Method in enum xsbti.Predefined

toValue(String) - Static method in enum xsbti.Predefined

U

uri() - Method in interface xsbti.Server

url() - Method in interface xsbti.IvyRepository

url() - Method in interface xsbti.MavenRepository

V

valueOf(String) - Static method in enum xsbti.CrossValue

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum xsbti.Predefined

Returns the enum constant of this type with the specified name.

values() - Static method in enum xsbti.CrossValue

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum xsbti.Predefined

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Method in interface xsbti.ApplicationID

version() - Method in exception xsbti.RetrieveException

version() - Method in interface xsbti.ScalaProvider

The version of Scala this instance provides.

X

xsbti - package xsbti

A B C D E F G I J L M N P R S T U V X