com.pervasive.datarush.cal

Class ClasspathSpecifier.Element

java.lang.Object

com.pervasive.datarush.cal.ClasspathSpecifier.Element

All Implemented Interfaces:

Serializable

Enclosing class:

ClasspathSpecifier

public static final class ClasspathSpecifier.Element
extends Object
implements Serializable

An element of a classpath. Elements may either be OSGI bundles or "plain old" java jars/directories. All elements must have a path object. In addition, elements may specify whether we are to cache the element on a per-node basis or on a per-job basis.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClasspathSpecifier.Element(Path path) Create a new classpath for the given path.
ClasspathSpecifier.Element(Path path, CacheScopeSpecifier cacheScope, boolean dynamic, OSGIOptions osgiOptions) Create a new classpath for the given path.

Method Summary

Methods

Modifier and Type	Method and Description
CacheScopeSpecifier	cacheScope() Returns the cacheScope of this element.
ClasspathSpecifier.Element	cacheScope(CacheScopeSpecifier cacheScope) Returns a new ClasspathElement, overriding the cacheScope.
boolean	dynamic() Returns whether the classpath element can be dynamically updated at runtime.
ClasspathSpecifier.Element	dynamic(boolean dynamic) Returns a new ClasspathElement, overriding dynamic.
OSGIOptions	osgiOptions() Returns the osgi options of this element.
ClasspathSpecifier.Element	osgiOptions(OSGIOptions osgiOptions) Returns a new ClasspathElement, overriding the osgiOptions.
Path	path() Returns the path of this classpath element.
ClasspathSpecifier.Element	path(Path path) Returns a new ClasspathElement, overriding the path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathSpecifier.Element

public ClasspathSpecifier.Element(Path path)

Create a new classpath for the given path.

Parameters:

path - the location of the element. May either be a directory or a file.

ClasspathSpecifier.Element

public ClasspathSpecifier.Element(Path path,
                          CacheScopeSpecifier cacheScope,
                          boolean dynamic,
                          OSGIOptions osgiOptions)

Create a new classpath for the given path.

Parameters:

path - the location of the element. May either be a directory or a file.

cacheScope - specifies where to cache the element

dynamic - if true, the classpath element will be scanned each time we run a job to see whether its checksum has changed. if false, the checksum will be cached in-memory so that the checksum is only recomputed upon restart.

osgiOptions - extra options for the case where this is an osgi classpath element. May be null in the case of a non-osgi element

Method Detail

path

public Path path()

Returns the path of this classpath element. The path may either be a directory or a file.

Returns:

the path of the classpath element.

cacheScope

public CacheScopeSpecifier cacheScope()

Returns the cacheScope of this element. The cache scope controls where the element is cached.

Returns:

the cache scope of this element

dynamic

public boolean dynamic()

Returns whether the classpath element can be dynamically updated at runtime. If true, the classpath element will be scanned each time we run a job to see whether its checksum has changed. if false, the checksum will be cached in-memory so that so that the checksum is only recomputed upon restart.

Returns:

whether the classpath element can be dynamically updated at runtime

osgiOptions

public OSGIOptions osgiOptions()

Returns the osgi options of this element. These are extra options applicable to the case where this is an osgi classpath element.

Returns:

the osgi options scope of this element

path

public ClasspathSpecifier.Element path(Path path)

Returns a new ClasspathElement, overriding the path.

Parameters:

path - the new path

Returns:

a newly created ClasspathElement

cacheScope

public ClasspathSpecifier.Element cacheScope(CacheScopeSpecifier cacheScope)

Returns a new ClasspathElement, overriding the cacheScope.

Parameters:

cacheScope - the new cacheScope

Returns:

a newly created ClasspathElement

dynamic

public ClasspathSpecifier.Element dynamic(boolean dynamic)

Returns a new ClasspathElement, overriding dynamic.

Parameters:

dynamic - the new value for dynamic

Returns:

a newly created ClasspathElement

osgiOptions

public ClasspathSpecifier.Element osgiOptions(OSGIOptions osgiOptions)

Returns a new ClasspathElement, overriding the osgiOptions.

Parameters:

osgiOptions - the new osgiOptions

Returns:

a newly created ClasspathElement