Package adams.core.management

Class ExternalResourceClassPathAugmenter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.option.AbstractSimpleOptionParser

adams.core.management.AbstractClassPathAugmenter

adams.core.management.ExternalResourceClassPathAugmenter

All Implemented Interfaces:

GlobalInfoSupporter, LoggingSupporter, ClassPathAugmenter, SimpleOptionParser, SizeOfHandler, Serializable

public class ExternalResourceClassPathAugmenter
extends AbstractClassPathAugmenter

Allows the user to add external jars and directories.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderDirectory[]	m_Directories	the directories with classes to add to the classpath.
protected PlaceholderFile[]	m_Files	the jars/zips to add to the classpath.

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ExternalResourceClassPathAugmenter()

Method Summary

Modifier and Type	Method	Description
String	directoriesTipText()	Returns the tip text for this property.
String	filesTipText()	Returns the tip text for this property.
String[]	getClassPathAugmentation()	Returns the classpath parts (jars, directories) to add to the classpath.
PlaceholderDirectory[]	getDirectories()	Returns the directories to add to the classpath.
PlaceholderFile[]	getFiles()	Returns the jar/zip files to add to the classpath.
net.sourceforge.argparse4j.inf.ArgumentParser	getParser()	Configures and returns the commandline parser.
String	globalInfo()	Returns a string describing the object.
void	setDirectories(PlaceholderDirectory[] value)	Sets the directories to add to the classpath.
void	setFiles(PlaceholderFile[] value)	Sets the jar/zip files to add to the classpath.
protected boolean	setOptions(net.sourceforge.argparse4j.inf.Namespace ns)	Sets the parsed options.

Methods inherited from class adams.core.option.AbstractSimpleOptionParser

forCommandline, setOptions

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_Files

protected PlaceholderFile[] m_Files

the jars/zips to add to the classpath.

m_Directories

protected PlaceholderDirectory[] m_Directories

the directories with classes to add to the classpath.

Constructor Detail

ExternalResourceClassPathAugmenter

public ExternalResourceClassPathAugmenter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Returns:

a description suitable for displaying in the gui

getParser

public net.sourceforge.argparse4j.inf.ArgumentParser getParser()

Configures and returns the commandline parser.

Specified by:

getParser in interface SimpleOptionParser

Overrides:

getParser in class AbstractSimpleOptionParser

Returns:

the parser

setOptions

protected boolean setOptions(net.sourceforge.argparse4j.inf.Namespace ns)

Sets the parsed options.

Overrides:

setOptions in class AbstractSimpleOptionParser

Parameters:

ns - the parsed options

Returns:

if successfully set

setFiles

public void setFiles(PlaceholderFile[] value)

Sets the jar/zip files to add to the classpath.

Parameters:

value - the jar/zip files

getFiles

public PlaceholderFile[] getFiles()

Returns the jar/zip files to add to the classpath.

Returns:

the jar/zip files

filesTipText

public String filesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setDirectories

public void setDirectories(PlaceholderDirectory[] value)

Sets the directories to add to the classpath.

Parameters:

value - the directories

getDirectories

public PlaceholderDirectory[] getDirectories()

Returns the directories to add to the classpath.

Returns:

the directories

directoriesTipText

public String directoriesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getClassPathAugmentation

public String[] getClassPathAugmentation()

Returns the classpath parts (jars, directories) to add to the classpath.

Returns:

the additional classpath parts