org.codehaus.mojo.appassembler.daemon.script

Class Platform

java.lang.Object

org.codehaus.mojo.appassembler.daemon.script.Platform

public class Platform
extends Object

Version:

$Id$

Author:

Trygve Laugstøl

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNIX_NAME Unix as Platform name.
static String	WINDOWS_NAME Windows Platform name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static Set<String>	getAllPlatformNames() Get the names of all available platforms.
static Set<Platform>	getAllPlatforms() Get all platforms.
String	getAppArguments(Daemon descriptor) Get the application arguments.
String	getBasedir()
String	getBinFileExtension()
String	getClassPath(Daemon daemon) Get the ClassPath based on the given Daemon.
String	getCommentPrefix()
String	getEnvSetup(Daemon daemon, String binFolder) Get the environment setup file.
String	getExtraJvmArguments(JvmSettings jvmSettings) Get the extra JVMArguments.
static Platform	getInstance(String platformName) Get an instance of the named platform.
String	getInterpolationToken() The interpolation token either for windows or unix.
String	getName() The name of the platform.
String	getNewLine()
String	getPathSeparator()
static Set<Platform>	getPlatformSet(List<String> platformList) Redefine the list of platforms with the given one.
static Set<Platform>	getPlatformSet(List<String> platformList, Set<Platform> allSet) Get back all platforms.
String	getRepo()
String	getSeparator()
int	hashCode()
boolean	isShowConsoleWindow(Daemon daemon) ShowConsole window.
void	setBinFileExtension(String binFileExtension) Set the bin file extension.

Methods inherited from class java.lang.Object

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

Field Detail

UNIX_NAME

public static final String UNIX_NAME

Unix as Platform name.

See Also:

Constant Field Values

WINDOWS_NAME

public static final String WINDOWS_NAME

Windows Platform name.

See Also:

Constant Field Values

Method Detail

getInstance

public static Platform getInstance(String platformName)
                            throws DaemonGeneratorException

Get an instance of the named platform.

Parameters:

platformName - The name of the wished platform.

Returns:

Instance of the platform.

Throws:

DaemonGeneratorException - in case of an wrong platformname.

getAllPlatformNames

public static Set<String> getAllPlatformNames()

Get the names of all available platforms.

Returns:

The names of the platform.

getAllPlatforms

public static Set<Platform> getAllPlatforms()

Get all platforms.

Returns:

All platforms.

getPlatformSet

public static Set<Platform> getPlatformSet(List<String> platformList)
                                    throws DaemonGeneratorException

Redefine the list of platforms with the given one.

Parameters:

platformList - The new list of platforms.

Returns:

The redefined platforms set.

Throws:

DaemonGeneratorException - in case of an error.

getPlatformSet

public static Set<Platform> getPlatformSet(List<String> platformList,
                           Set<Platform> allSet)
                                    throws DaemonGeneratorException

Get back all platforms.

Parameters:

platformList - The list of platforms.

allSet - The all set list.

Returns:

Get the platform sets.

Throws:

DaemonGeneratorException - in case of an error.

getInterpolationToken

public String getInterpolationToken()

The interpolation token either for windows or unix.

Returns:

The token which is used.

getBinFileExtension

public String getBinFileExtension()

Returns:

The binary extension.

getBasedir

public String getBasedir()

Returns:

BASEDIR representation for windows or unix.

getRepo

public String getRepo()

Returns:

REPO representation for windows or unix.

getSeparator

public String getSeparator()

Returns:

The separator for windows or unix.

getPathSeparator

public String getPathSeparator()

Returns:

The path separator for windows or unix.

getCommentPrefix

public String getCommentPrefix()

Returns:

Comment prefix for windows or unix.

getNewLine

public String getNewLine()

getClassPath

public String getClassPath(Daemon daemon)
                    throws DaemonGeneratorException

Get the ClassPath based on the given Daemon.

Parameters:

daemon - The Daemon instance.

Returns:

The classpath as a string.

Throws:

DaemonGeneratorException - in case of an error.

getExtraJvmArguments

public String getExtraJvmArguments(JvmSettings jvmSettings)
                            throws IOException

Get the extra JVMArguments.

Parameters:

jvmSettings - The JVM settings

Returns:

The created string which contains -X options for the JVM settings.

Throws:

IOException - in case of an error.

getAppArguments

public String getAppArguments(Daemon descriptor)

Get the application arguments.

Parameters:

descriptor - Instance of the daemon descriptor.

Returns:

The list of application arguments.

getEnvSetup

public String getEnvSetup(Daemon daemon,
                 String binFolder)

Get the environment setup file.

Parameters:

daemon - The instance of the Daemon for which this is beeing produced.

Returns:

The created string which contains the path to the setup file.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

The name of the platform.

Returns:

The name of the platform.

isShowConsoleWindow

public boolean isShowConsoleWindow(Daemon daemon)

ShowConsole window.

Parameters:

daemon -

Returns:

true yes false otherwise.

setBinFileExtension

public void setBinFileExtension(String binFileExtension)

Set the bin file extension.

Parameters:

binFileExtension - The extension of the binary file.