com.threecrickets.sincerity

Class Container<M extends Module,R extends Repositories>

java.lang.Object

com.threecrickets.sincerity.util.RootDirectory

com.threecrickets.sincerity.Container<M,R>

Type Parameters:

M - The resolved dependency class

R - The repositories class

Direct Known Subclasses:

IvyContainer

public abstract class Container<M extends Module,R extends Repositories>
extends RootDirectory

The second highest level instance for the Sincerity runtime, after the Sincerity class.

While strictly speaking it is a singleton, several Container instances may coexist via the Bootstrap mechanism. This is in order to allow Sincerity to "reboot" itself using a new classpath in case the Container is changed. See Sincerity.reboot().

Because the set of plugins in a container depends on its classpath, this is also where you can access them, via getPlugins().

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARTIFACTS_CONF
static String	DEPENDENCIES_CONF
static String	IVY_CONF
static String	REPOSITORIES_CONF
static String	SHORTCUTS_CONF
static String	SINCERITY_DIR

Constructor Summary

Constructors

Constructor and Description
Container(Sincerity sincerity, File root, int debugLevel) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addInstallation() Increase the number of installations by one.
Bootstrap	createBootstrap() Creates a new bootstrap based on the classpath.
PackagingContext	createPackagingContext() Creates a packaging context for the container.
Bootstrap	getBootstrap() The cached bootstrap.
Bootstrap	getBootstrap(boolean forceCreate) The bootstrap, whether cached or explicitly (re)created.
File	getCacheFile(String... parts) Constructs an absolute path from the "cache" subdirectory.
File	getConfigurationFile(String... parts) Constructs an absolute path from the "configuration" subdirectory.
abstract Dependencies<M>	getDependencies() The specified and resolved dependencies.
File	getExecutablesFile(String... parts) Constructs an absolute path from the "executables" subdirectory.
int	getInstallations()
LanguageManager	getLanguageManager() The cached Scripturian language manager, based on the current bootstrap.
File	getLibrariesFile(String... parts) Constructs an absolute path from the "libraries" subdirectory.
File	getLogsFile(String... parts) Constructs an absolute path from the "logs" subdirectory.
ParserManager	getParserManager() The cached Scripturian parser manager, based on the current bootstrap.
Plugins	getPlugins() The cached plugins, based on the current bootstrap.
List<String>	getPrograms() The names of all files under the "programs" subdirectory without their extensions.
File	getProgramsFile(String... parts) Constructs an absolute path from the "programs" subdirectory.
abstract R	getRepositories() The specified repositories.
Shortcuts	getShortcuts() The shortcuts.
Sincerity	getSincerity() The Sincerity instance.
File	getSincerityFile(String... parts) Constructs an absolute path from the Sincerity root directory.
boolean	hasChanged()
boolean	hasFinishedInstalling()
void	initializeProgress() Sets setChanged(boolean) to false and setHasFinishedInstalling(boolean) to true.
void	setChanged(boolean hasChanged) True if the dependencies have been changed, requiring a new bootstrap.
void	setHasFinishedInstalling(boolean hasFinishedInstalling) True if dependencies have finished installing.
void	setInstallations(int installations) The number of installation attempts for this root directory.
void	transferProgress(org.apache.ivy.plugins.repository.TransferEvent event)
void	updateBootstrap() Recreates and caches the bootstrap.

Methods inherited from class com.threecrickets.sincerity.util.RootDirectory

getAbsoluteFile, getFile, getRelativeFile, getRelativePath, getRelativePath, getRoot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINCERITY_DIR

public static final String SINCERITY_DIR

See Also:

Constant Field Values

IVY_CONF

public static final String IVY_CONF

See Also:

Constant Field Values

REPOSITORIES_CONF

public static final String REPOSITORIES_CONF

See Also:

Constant Field Values

DEPENDENCIES_CONF

public static final String DEPENDENCIES_CONF

See Also:

Constant Field Values

ARTIFACTS_CONF

public static final String ARTIFACTS_CONF

See Also:

Constant Field Values

SHORTCUTS_CONF

public static final String SHORTCUTS_CONF

See Also:

Constant Field Values

Constructor Detail

Container

public Container(Sincerity sincerity,
                 File root,
                 int debugLevel)
          throws SincerityException

Constructor.

Parameters:

sincerity - The Sincerity instance

root - The container root directory

debugLevel - The Ivy debug level

Throws:

SincerityException - In case of an error

See Also:

DefaultMessageLogger

Method Detail

getSincerity

public Sincerity getSincerity()

The Sincerity instance.

Returns:

The Sincerity instance

getDependencies

public abstract Dependencies<M> getDependencies()

The specified and resolved dependencies.

Returns:

The dependencies

getRepositories

public abstract R getRepositories()

The specified repositories.

Returns:

The repositories

getShortcuts

public Shortcuts getShortcuts()

The shortcuts.

Returns:

The shortcuts

getPlugins

public Plugins getPlugins()
                   throws SincerityException

The cached plugins, based on the current bootstrap.

Returns:

The plugins

Throws:

SincerityException - In case of an error

getBootstrap

public Bootstrap getBootstrap()
                       throws SincerityException

The cached bootstrap.

Returns:

The bootstrap

Throws:

SincerityException - In case of an error

getBootstrap

public Bootstrap getBootstrap(boolean forceCreate)
                       throws SincerityException

The bootstrap, whether cached or explicitly (re)created.

Parameters:

forceCreate - True to ignore cached value and force creation

Returns:

The bootstrap

Throws:

SincerityException - In case of an error

See Also:

createBootstrap()

getLanguageManager

public LanguageManager getLanguageManager()
                                   throws SincerityException

The cached Scripturian language manager, based on the current bootstrap.

Contains explicit support for Python and Velocity.

Returns:

The language manager

Throws:

SincerityException - In case of an error

getParserManager

public ParserManager getParserManager()
                               throws SincerityException

The cached Scripturian parser manager, based on the current bootstrap.

Returns:

The parser manager

Throws:

SincerityException - In case of an error

createPackagingContext

public PackagingContext createPackagingContext()
                                        throws SincerityException

Creates a packaging context for the container.

Returns:

A packaging context

Throws:

SincerityException - In case of an error

getSincerityFile

public File getSincerityFile(String... parts)

Constructs an absolute path from the Sincerity root directory.

Parameters:

parts - The path parts

Returns:

The absolute file

getConfigurationFile

public File getConfigurationFile(String... parts)

Constructs an absolute path from the "configuration" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getLogsFile

public File getLogsFile(String... parts)

Constructs an absolute path from the "logs" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getCacheFile

public File getCacheFile(String... parts)

Constructs an absolute path from the "cache" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getLibrariesFile

public File getLibrariesFile(String... parts)

Constructs an absolute path from the "libraries" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getProgramsFile

public File getProgramsFile(String... parts)

Constructs an absolute path from the "programs" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getExecutablesFile

public File getExecutablesFile(String... parts)

Constructs an absolute path from the "executables" subdirectory.

Parameters:

parts - The path parts

Returns:

The absolute file

getPrograms

public List<String> getPrograms()
                         throws SincerityException

The names of all files under the "programs" subdirectory without their extensions.

Returns:

The programs

Throws:

SincerityException - In case of an error

hasChanged

public boolean hasChanged()

Returns:

True if changed

See Also:

setChanged(boolean)

setChanged

public void setChanged(boolean hasChanged)

True if the dependencies have been changed, requiring a new bootstrap.

Parameters:

hasChanged - True if changed

hasFinishedInstalling

public boolean hasFinishedInstalling()

Returns:

True if finished installing

See Also:

setHasFinishedInstalling(boolean)

setHasFinishedInstalling

public void setHasFinishedInstalling(boolean hasFinishedInstalling)

True if dependencies have finished installing.

Parameters:

hasFinishedInstalling - True if finished installing

getInstallations

public int getInstallations()

Returns:

The number of installations

See Also:

setInstallations(int)

setInstallations

public void setInstallations(int installations)

The number of installation attempts for this root directory.

Note that this value will persist even if this class is re-instantiated.

Parameters:

installations - The number of installations

See Also:

addInstallation()

addInstallation

public void addInstallation()

Increase the number of installations by one.

See Also:

setInstallations(int)

initializeProgress

public void initializeProgress()

Sets setChanged(boolean) to false and setHasFinishedInstalling(boolean) to true.

createBootstrap

public Bootstrap createBootstrap()
                          throws SincerityException

Creates a new bootstrap based on the classpath.

Returns:

A bootstrap

Throws:

SincerityException - In case of an error

updateBootstrap

public void updateBootstrap()
                     throws SincerityException

Recreates and caches the bootstrap.

Throws:

SincerityException - In case of an error

See Also:

getBootstrap(boolean)

transferProgress

public void transferProgress(org.apache.ivy.plugins.repository.TransferEvent event)