com.threecrickets.sincerity

Class Sincerity

java.lang.Object

com.threecrickets.sincerity.Sincerity

All Implemented Interfaces:

Runnable

public class Sincerity
extends Object
implements Runnable

This is the highest level instance for the Sincerity runtime.

While strictly speaking it is a singleton, several Sincerity 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 reboot().

The main role of this class is to manage the Container singleton. Indeed, Sincerity can run without a container, and this class can be used to create it.

This is also where you can access the "system" plugins, those that are part of the Sincerity base installation and are not associated with any container. See getPlugins().

Additionally, this class manages the general runtime environment and interface for all of Sincerity. This includes both the command line interface (CLI) and the graphical user interface (GUI).

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTAINER_ENV
static String	CONTAINER_PROPERTY
static String	CONTAINER_ROOT_ATTRIBUTE
static String	DEBUG_ENV
static String	DEBUG_PROPERTY
static String	ERR_ATTRIBUTE
static String	OUT_ATTRIBUTE
static String	STARTED_ATTRIBUTE
static String	VERBOSITY_ATTRIBUTE
static String	VERSION_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
Sincerity(String[] arguments) Constructor.
Sincerity(String[] arguments, Sincerity sincerity) Cloning constructor.

Method Summary

Modifier and Type	Method and Description
void	captureOutput(Process process) Captures the standard output and standard error of a process.
void	createContainer(File containerRoot, File templateDir, boolean force) Creates a new container based on a template and sets it as the current container.
void	dumpStackTrace(Throwable x) Dumps an exception's stack trace to standard error.
<RD extends Module,R extends Repositories> Container<RD,R>	getContainer() The current container.
File	getContainerRoot() The root directory of the current container.
static Sincerity	getCurrent() The Sincerity instance running in the current thread.
PrintWriter	getErr()
Frame	getFrame()
File	getHome() The Sincerity home directory
File	getHomeFile(String... parts) Constructs an absolute path from the home directory.
PrintWriter	getOut()
Plugins	getPlugins() The plugins.
String	getRelativeHomePath(File file) If the file is under to the root directory, returns a relative path.
String	getRelativeHomePath(String path) If the path is under to the root directory, returns a relative path.
List<Template>	getTemplates() The available templates (names of directory in the "/templates/" subdirectory of the Sincerity install).
int	getTerminalHeight() The terminal height
int	getTerminalWidth() The terminal width.
int	getVerbosity()
Map<String,String>	getVersion() Sincerity version information (cached as a bootstrap attribute).
boolean	isTerminalAnsi() Whether the terminal supports ANSI codes.
static void	main(String[] arguments) Executes a Sincerity command line, defaulting to the "shell:console" command if no commands are given.
void	reboot() Reboots Sincerity without forcing a new container bootstrap.
void	reboot(boolean forceNewBootstrap) Reboots Sincerity, resubmitting the current command queue to the new instance.
protected void	removeCommand(Command command) Removes a command from the current command queue.
void	run()
void	run(Object... arguments) Runs a command line with the current set of plugs.
void	setContainerRoot(File containerRoot) Changes the current container by specifying a new root directory.
void	setErr(Writer err) The standard error writer.
void	setFrame(Frame frame) The current open GUI frame.
void	setOut(Writer out) The standard output writer.
void	setVerbosity(int verbosity) Verbosity is only used to control messages to standard output and standard error

Methods inherited from class java.lang.Object

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

Field Detail

CONTAINER_PROPERTY

public static final String CONTAINER_PROPERTY

See Also:

Constant Field Values

CONTAINER_ENV

public static final String CONTAINER_ENV

See Also:

Constant Field Values

DEBUG_PROPERTY

public static final String DEBUG_PROPERTY

See Also:

Constant Field Values

DEBUG_ENV

public static final String DEBUG_ENV

See Also:

Constant Field Values

VERSION_ATTRIBUTE

public static final String VERSION_ATTRIBUTE

See Also:

Constant Field Values

CONTAINER_ROOT_ATTRIBUTE

public static final String CONTAINER_ROOT_ATTRIBUTE

See Also:

Constant Field Values

STARTED_ATTRIBUTE

public static final String STARTED_ATTRIBUTE

See Also:

Constant Field Values

VERBOSITY_ATTRIBUTE

public static final String VERBOSITY_ATTRIBUTE

See Also:

Constant Field Values

OUT_ATTRIBUTE

public static final String OUT_ATTRIBUTE

See Also:

Constant Field Values

ERR_ATTRIBUTE

public static final String ERR_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Sincerity

public Sincerity(String[] arguments)
          throws SincerityException

Constructor.

Parameters:

arguments - The command line

Throws:

SincerityException - In case of an error

Sincerity

public Sincerity(String[] arguments,
                 Sincerity sincerity)
          throws SincerityException

Cloning constructor.

Parameters:

arguments - The command line

sincerity - The instance to clone

Throws:

SincerityException - In case of an error

Method Detail

getCurrent

public static Sincerity getCurrent()

The Sincerity instance running in the current thread.

Returns:

The Sincerity instance

main

public static void main(String[] arguments)

Executes a Sincerity command line, defaulting to the "shell:console" command if no commands are given.

Parameters:

arguments - The command line

getVersion

public Map<String,String> getVersion()

Sincerity version information (cached as a bootstrap attribute).

Taken from the "version.conf" resource.

Returns:

Version information

getHome

public File getHome()
             throws SincerityException

The Sincerity home directory

Returns:

The home directory

Throws:

SincerityException - In case of an error

getHomeFile

public File getHomeFile(String... parts)
                 throws SincerityException

Constructs an absolute path from the home directory.

Parameters:

parts - The path parts

Returns:

The absolute file

Throws:

SincerityException - In case of an error

getRelativeHomePath

public String getRelativeHomePath(File file)
                           throws SincerityException

If the file is under to the root directory, returns a relative path.

Parameters:

file - The absolute file

Returns:

The relative path

Throws:

SincerityException - In case of an error

See Also:

getRelativeHomePath(File)

getRelativeHomePath

public String getRelativeHomePath(String path)
                           throws SincerityException

If the path is under to the root directory, returns a relative path.

Parameters:

path - The absolute path

Returns:

The relative path

Throws:

SincerityException - In case of an error

See Also:

getRelativeHomePath(File)

getVerbosity

public int getVerbosity()

Returns:

The verbosity level

See Also:

setVerbosity(int)

setVerbosity

public void setVerbosity(int verbosity)

Verbosity is only used to control messages to standard output and standard error

It is interpreted individually by individual commands, though 0 usually means "silent," 1 means "only important messages" and 2 means "quite chatty." Higher values usually include more minute debugging information.

Parameters:

verbosity - The verbosity level

See Also:

getVerbosity()

getOut

public PrintWriter getOut()

Returns:

The print writer

See Also:

setOut(Writer)

setOut

public void setOut(Writer out)

The standard output writer.

Will be wrapped in a PrintWriter if it's not already one.

Parameters:

out - The writer

See Also:

getOut()

getErr

public PrintWriter getErr()

Returns:

The print writer

See Also:

setErr(Writer)

setErr

public void setErr(Writer err)

The standard error writer.

Will be wrapped in a PrintWriter if it's not already one.

Parameters:

err - The writer

isTerminalAnsi

public boolean isTerminalAnsi()

Whether the terminal supports ANSI codes.

Returns:

Whether the terminal supports ANSI codes

getTerminalWidth

public int getTerminalWidth()

The terminal width.

Returns:

The terminal width

getTerminalHeight

public int getTerminalHeight()

The terminal height

Returns:

The terminal height

getContainerRoot

public File getContainerRoot()
                      throws SincerityException

The root directory of the current container.

Returns:

The canonical file

Throws:

SincerityException - In case of an error

See Also:

setContainerRoot(File)

setContainerRoot

public void setContainerRoot(File containerRoot)
                      throws SincerityException

Changes the current container by specifying a new root directory.

Causes a reboot() if the current container is changed!

Parameters:

containerRoot - The container root

Throws:

SincerityException - In case of an error

See Also:

getContainerRoot()

getContainer

public <RD extends Module,R extends Repositories> Container<RD,R> getContainer()
                                                                        throws SincerityException

The current container.

Creates a new instance if not previously accessed.

Type Parameters:

RD - The resolved dependency class

R - The repositories class

Returns:

The container

Throws:

SincerityException - In case of an error

getPlugins

public Plugins getPlugins()
                   throws SincerityException

The plugins.

If there is a current container, then we will include its classpath. Otherwise, we will only consider the Sincerity home plugins.

Returns:

The plugins

Throws:

SincerityException - In case of an error

getFrame

public Frame getFrame()

Returns:

The GUI frame or null

See Also:

setFrame(Frame)

setFrame

public void setFrame(Frame frame)

The current open GUI frame.

Parameters:

frame - The GUI frame

See Also:

getFrame()

getTemplates

public List<Template> getTemplates()
                            throws SincerityException

The available templates (names of directory in the "/templates/" subdirectory of the Sincerity install).

Returns:

The templates

Throws:

SincerityException - In case of an error

createContainer

public void createContainer(File containerRoot,
                            File templateDir,
                            boolean force)
                     throws SincerityException

Creates a new container based on a template and sets it as the current container.

Unless force is true, will not copy any files if the directory already exists.

Parameters:

containerRoot - The container root directory

templateDir - The template root directory

force - True to force overriding of existing files

Throws:

SincerityException - In case of an error

run

public void run(Object... arguments)
         throws SincerityException

Runs a command line with the current set of plugs. Supports expanding shortcuts.

Parameters:

arguments - The command arguments

Throws:

SincerityException - In case of an error

See Also:

getPlugins()

reboot

public void reboot()
            throws SincerityException

Reboots Sincerity without forcing a new container bootstrap.

Throws:

SincerityException - In case of an error

See Also:

reboot(boolean)

reboot

public void reboot(boolean forceNewBootstrap)
            throws SincerityException

Reboots Sincerity, resubmitting the current command queue to the new instance.

Parameters:

forceNewBootstrap - True to force the re-creation of the container's bootstrap

Throws:

SincerityException - In case of an error

captureOutput

public void captureOutput(Process process)

Captures the standard output and standard error of a process.

Parameters:

process - The process

See Also:

setOut(Writer), setErr(Writer)

dumpStackTrace

public void dumpStackTrace(Throwable x)

Dumps an exception's stack trace to standard error.

Parameters:

x - The exception

See Also:

setErr(Writer)

run

public void run()

Specified by:

run in interface Runnable

removeCommand

protected void removeCommand(Command command)

Removes a command from the current command queue.

Parameters:

command - The command