Apache Groovy 3.0.20 · org.codehaus.groovy.tools.LoaderConfiguration

Class used to configure a RootLoader from a stream or by using its methods.

The stream can be for example a FileInputStream from a file with the following format:

# comment
main is classname
load path
load file
load pathWith${property}
load pathWith!{required.property}
load path/*.jar
load path/**/*.jar

All lines starting with "#" are ignored.
The "main is" part may only be once in the file. The String afterwards is the name of a class with a main method.
The "load" command will add the given file or path to the classpath in this configuration object. If the path does not exist, the path will be ignored.
properties referenced using !{x} are required.
properties referenced using ${x} are not required. If the property does not exist the whole load instruction line will be ignored.
* is used to match zero or more characters in a file.
** is used to match zero or more directories.
Loading paths with load ./*.jar or load *.jar are not supported.

Defining the main class is required unless setRequireMain(boolean) is called with false, before reading the configuration. You can use the wildcard "*" to filter the path, but only for files, not directories. To match directories use "**". The ${propertyname} is replaced by the value of the system's property name. You can use user.home here for example. If the property does not exist, an empty string will be used. If the path or file after the load command does not exist, the path will be ignored.

Field Summary

Modifier and Type	Field and Description
private static final String	ALL_WILDCARD
private final List<URL>	classPath
private static final String	CONFIGSCRIPT_PREFIX
private final List<String>	configScripts
private static final String	GRAB_PREFIX
private final List<String>	grabList
private static final String	LOAD_PREFIX
private String	main
private static final String	MAIN_PREFIX
private static final String	MATCH_ALL
private static final String	MATCH_FILE_NAME
private static final String	PROP_PREFIX
private boolean	requireMain
private static final char	WILDCARD

Constructor Summary

Access	Constructor and Description
public	LoaderConfiguration() creates a new loader configuration

Method Summary

Modifier and Type	Method and Description
public void	addClassPath(String the path as a path separator delimited string path) Adds a classpath to this configuration.
public void	addFile(File the file to add file) Adds a file to the classpath if it exists.
public void	addFile(String the name of the file to add filename) Adds a file to the classpath if it exists.
private static String	assignProperties(String str)
public void	configure(InputStream stream used to read the configuration is) configures this loader with a stream
private static String	correctDoubleSlash(String propertyValue, int propertyIndexEnd, String str)
private void	findMatchingFiles(File[] files, Pattern pattern, boolean recursive)
public URL[]	Returns: the classpath getClassPathUrls() The classpath as URL[] from this configuration.
public List<String>	Returns: the list of grab urls getGrabUrls() The extra grab configuration.
public String	Returns: the name of the main class or null if not defined getMainClass() Returns the name of the main class for this configuration.
private static String	getSlashyPath(final String path)
private void	loadFilteredPath(String filter)
public void	setMainClass(String the name to become the main class classname) Sets the main class.
public void	setRequireMain(boolean set to false if no main class is required requireMain) Determines if a main class is required when calling.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALL_WILDCARD	back to summary
private static final String ALL_WILDCARD

classPath	back to summary
private final List<URL> classPath

CONFIGSCRIPT_PREFIX	back to summary
private static final String CONFIGSCRIPT_PREFIX

configScripts	back to summary
private final List<String> configScripts

GRAB_PREFIX	back to summary
private static final String GRAB_PREFIX

grabList	back to summary
private final List<String> grabList

LOAD_PREFIX	back to summary
private static final String LOAD_PREFIX

main	back to summary
private String main

MAIN_PREFIX	back to summary
private static final String MAIN_PREFIX

MATCH_ALL	back to summary
private static final String MATCH_ALL

MATCH_FILE_NAME	back to summary
private static final String MATCH_FILE_NAME

PROP_PREFIX	back to summary
private static final String PROP_PREFIX

requireMain	back to summary
private boolean requireMain

WILDCARD	back to summary
private static final char WILDCARD

Constructor Detail

LoaderConfiguration	back to summary
public LoaderConfiguration() creates a new loader configuration

Method Detail

addClassPath back to summary

addClassPath	back to summary
public void addClassPath(String path) Adds a classpath to this configuration. It expects a string with multiple paths, separated by the system dependent path separator. Expands wildcards, e.g. dir/* into all the jars in dir. Parameters path:String the path as a path separator delimited string See Also `java.io.File#pathSeparator`

public void addClassPath(String path)

Adds a classpath to this configuration. It expects a string with multiple paths, separated by the system dependent path separator. Expands wildcards, e.g. dir/* into all the jars in dir.

Parameters

path:String: the path as a path separator delimited string

See Also

java.io.File#pathSeparator

addFile	back to summary
public void addFile(File file) Adds a file to the classpath if it exists. Parameters file:File the file to add

addFile

back to summary

public void addFile(File file)

Adds a file to the classpath if it exists.

Parameters

file:File: the file to add

addFile	back to summary
public void addFile(String filename) Adds a file to the classpath if it exists. Parameters filename:String the name of the file to add

addFile

back to summary

public void addFile(String filename)

Adds a file to the classpath if it exists.

Parameters

filename:String: the name of the file to add

assignProperties	back to summary
private static String assignProperties(String str)

configure	back to summary
public void configure(InputStream is) throws IOException configures this loader with a stream Parameters is:InputStream stream used to read the configuration Exceptions IOException: if reading or parsing the contents of the stream fails

configure

back to summary

public void configure(InputStream is) throws IOException

configures this loader with a stream

Parameters

is:InputStream: stream used to read the configuration

Exceptions

IOException:: if reading or parsing the contents of the stream fails

correctDoubleSlash	back to summary
private static String correctDoubleSlash(String propertyValue, int propertyIndexEnd, String str)

findMatchingFiles	back to summary
private void findMatchingFiles(File[] files, Pattern pattern, boolean recursive)

getClassPathUrls back to summary

getClassPathUrls	back to summary
public URL[] getClassPathUrls() The classpath as URL[] from this configuration. This can be used to construct a class loader. Returns:URL[] the classpath See Also `java.net.URLClassLoader`

public URL[] getClassPathUrls()

The classpath as URL[] from this configuration. This can be used to construct a class loader.

Returns:URL[]: the classpath
See Also: java.net.URLClassLoader

getGrabUrls	back to summary
public List<String> getGrabUrls() The extra grab configuration. Returns:List<String> the list of grab urls

getGrabUrls

back to summary

public List<String> getGrabUrls()

The extra grab configuration.

Returns:List<String>: the list of grab urls

getMainClass	back to summary
public String getMainClass() Returns the name of the main class for this configuration. Returns:String the name of the main class or null if not defined

getMainClass

back to summary

public String getMainClass()

Returns the name of the main class for this configuration.

Returns:String: the name of the main class or null if not defined

getSlashyPath	back to summary
private static String getSlashyPath(final String path)

loadFilteredPath	back to summary
private void loadFilteredPath(String filter)

setMainClass back to summary

setMainClass	back to summary
public void setMainClass(String classname) Sets the main class. If there is already a main class it is overwritten. Calling `configure(InputStream)` after calling this method does not require a main class definition inside the stream. Parameters classname:String the name to become the main class

public void setMainClass(String classname)

Sets the main class. If there is already a main class it is overwritten. Calling configure(InputStream) after calling this method does not require a main class definition inside the stream.

Parameters

classname:String: the name to become the main class

setRequireMain back to summary

setRequireMain	back to summary
public void setRequireMain(boolean requireMain) Determines if a main class is required when calling. Parameters requireMain:boolean set to false if no main class is required See Also `configure(InputStream)`

public void setRequireMain(boolean requireMain)

Determines if a main class is required when calling.

Parameters

requireMain:boolean: set to false if no main class is required

See Also

configure(InputStream)

public Class LoaderConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail