uk.co.bigbeeconsultants.bconfig

Class ClasspathConfigSourceJ

java.lang.Object

uk.co.bigbeeconsultants.bconfig.ConfigSourceJ

uk.co.bigbeeconsultants.bconfig.ClasspathConfigSourceJ

public class ClasspathConfigSourceJ
extends ConfigSourceJ

Sources configuration data from a resource on the classpath.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	resourcePath

Constructor Summary

Constructors

Constructor and Description
ClasspathConfigSourceJ(java.lang.String resourcePath) Sources configuration data from a resource on the classpath.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeOpened() Tests whether this source can be opened [again].
long	lastModifiedTime() Provides the timestamp so that source file changes can be observed.
java.lang.String	name() The file name or similar that identifies the underlying resource.
protected java.io.InputStream	openTheSource() Implementations must provide the means to open their input stream in the necessary way.

Methods inherited from class uk.co.bigbeeconsultants.bconfig.ConfigSourceJ

open, timesOpened

Methods inherited from class java.lang.Object

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

Field Detail

resourcePath

public final java.lang.String resourcePath

Constructor Detail

ClasspathConfigSourceJ

public ClasspathConfigSourceJ(java.lang.String resourcePath)

Sources configuration data from a resource on the classpath.

Parameters:

resourcePath - the classpath name of the resource to be loaded.

Method Detail

name

public java.lang.String name()

Description copied from class: ConfigSourceJ

The file name or similar that identifies the underlying resource. This is used for error messages.

Specified by:

name in class ConfigSourceJ

lastModifiedTime

public long lastModifiedTime()

Description copied from class: ConfigSourceJ

Provides the timestamp so that source file changes can be observed.

Specified by:

lastModifiedTime in class ConfigSourceJ

Returns:

the last modified timestamp if known, zero otherwise.

canBeOpened

public boolean canBeOpened()

Description copied from class: ConfigSourceJ

Tests whether this source can be opened [again]. If this returns false, it is wise to assume that `open` will throw an exception.

Specified by:

canBeOpened in class ConfigSourceJ

openTheSource

protected java.io.InputStream openTheSource()
                                     throws java.io.FileNotFoundException

Description copied from class: ConfigSourceJ

Implementations must provide the means to open their input stream in the necessary way.

Specified by:

openTheSource in class ConfigSourceJ

Throws:

java.io.FileNotFoundException