uk.co.bigbeeconsultants.bconfig

Class FileConfigSourceJ

java.lang.Object

uk.co.bigbeeconsultants.bconfig.ConfigSourceJ

uk.co.bigbeeconsultants.bconfig.FileConfigSourceJ

public class FileConfigSourceJ
extends ConfigSourceJ

Sources configuration data from a file.

Field Summary

Fields

Modifier and Type	Field and Description
java.io.File	file

Constructor Summary

Constructors

Constructor and Description
FileConfigSourceJ(java.io.File file) Sources configuration data from a file.

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.
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

file

public final java.io.File file

Constructor Detail

FileConfigSourceJ

public FileConfigSourceJ(java.io.File file)

Sources configuration data from a file.

Parameters:

file - the file in question. This can also be used directly, e.g. to test whether the file exists at a given moment.

Method Detail

lastModifiedTime

public final 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 final 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

public final 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

name

public final 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