uk.co.bigbeeconsultants.bconfig

Class ReadableOnceConfigSourceJ

java.lang.Object

uk.co.bigbeeconsultants.bconfig.ConfigSourceJ

uk.co.bigbeeconsultants.bconfig.ReadableOnceConfigSourceJ

public class ReadableOnceConfigSourceJ
extends ConfigSourceJ

Sources configuration data from an input stream that will be read once only then closed. The name is used in exception messages should any arise. After the input stream has been opened once, an IllegalStateException is thrown on any subsequent attempt to open it.

Constructor Summary

Constructors

Constructor and Description
ReadableOnceConfigSourceJ(java.io.InputStream in, java.lang.String name) Sources configuration data from an input stream that will be read once only then closed.

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

Constructor Detail

ReadableOnceConfigSourceJ

public ReadableOnceConfigSourceJ(java.io.InputStream in,
                         java.lang.String name)

Sources configuration data from an input stream that will be read once only then closed. The name is used in exception messages should any arise. After the input stream has been opened once, an IllegalStateException is thrown on any subsequent attempt to open it.

Parameters:

in - the input stream to be consumed

name - a name that will be used in error messages (any string)

Method Detail

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()

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

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