Module datarush.commons

Package com.pervasive.datarush.cal

Class ClasspathSpecifier

java.lang.Object

com.pervasive.datarush.cal.ClasspathSpecifier

All Implemented Interfaces:

Serializable

public final class ClasspathSpecifier
extends Object
implements Serializable

The classpath specifies for a job. The classpath refers to files and directories on the local machine that are to be included in the classpath of the executing job. In the event that osgi is enabled, the entities in the classpath must refer to OSGI plugins (either jars or directories).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClasspathSpecifier.Element	An element of a classpath.

Constructor Summary

Constructors

Constructor	Description
ClasspathSpecifier(boolean osgi, List<ClasspathSpecifier.Element> classpath)	Create a new classpath specifier.

Method Summary

Modifier and Type	Method	Description
List<ClasspathSpecifier.Element>	classpath()	Returns the classpath consisting of elements on the client machine
static ClasspathSpecifier	defaultSpecifier()	Returns the default classpath specifier based on the system property java.class.path.
boolean	osgi()	Returns whether osgi is enabled
ClasspathSpecifier	resolve()	If this is the default, this will force resolution of the default classpath.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathSpecifier

public ClasspathSpecifier(boolean osgi,
                          List<ClasspathSpecifier.Element> classpath)

Create a new classpath specifier.

Parameters:

osgi - whether to run in osgi mode.

classpath - the classpath consisting of elements on the client machine

Method Detail

defaultSpecifier

public static ClasspathSpecifier defaultSpecifier()

Returns the default classpath specifier based on the system property java.class.path. By default, directories have CacheScopeSpecifier.JOB scope and Files have CacheScopeSpecifier.NODE scope. Note that the java.class.path system property is not immediately resolved. A call to resolve() can be used to force resolution.

Returns:

the default classpath specifier

osgi

public boolean osgi()

Returns whether osgi is enabled

Returns:

whether osgi is enabled

classpath

public List<ClasspathSpecifier.Element> classpath()

Returns the classpath consisting of elements on the client machine

Returns:

the classpath

resolve

public ClasspathSpecifier resolve()

If this is the default, this will force resolution of the default classpath. Otherwise it will return an instance of "this".

Returns:

a resolved classpath specifier.

toString

public String toString()

Overrides:

toString in class Object