com.bankframe.services.resource
Class BaseBankFrameResource

java.lang.Object
  com.bankframe.services.resource.BaseBankFrameResource

All Implemented Interfaces:

BankFrameResource

Direct Known Subclasses:

BankFrameResourceBundle

public abstract class BaseBankFrameResource

extends java.lang.Object

implements BankFrameResource

Field Summary

static long	DEFAULT_REFRESH_INTERVAL
static java.lang.String	REFRESH_INTERVAL_KEY

Method Summary

java.lang.Object	get(java.lang.String key) This method gets a value.
java.lang.Boolean	getBoolean(java.lang.String keyName) This method gets the value of the specified property as a Boolean value.
java.lang.String	getDescription(java.lang.String key) This method gets a textual description for the specified key (or subset)
java.lang.String	getDescription(java.lang.String key, java.util.Locale locale) This method gets a textual description for the specified key (or subset) localised to the specified locale
java.lang.Double	getDouble(java.lang.String keyName) This method gets the value of the specified property as a Double object.
java.lang.Integer	getInteger(java.lang.String keyName) This method gets the value of the specified property as an Integer object.
java.lang.Long	getLong(java.lang.String keyName) This method gets the value of the specified property as a Long object.
java.lang.String	getString(java.lang.String key) This method gets a value.
BankFrameResource	getSubset(java.lang.String prefix) This method gets a subset of values whose keys all begin with the specified prefix.
java.net.URL	getUrl() This method gets the URL for this resource.
java.util.Enumeration	keys() The method gets all the keys in this cache
java.lang.Object	put(java.lang.String key, java.lang.Object value) This method adds a key/value to the resource.
void	remove(java.util.Enumeration keys) This method removes keys from the resource.
java.lang.Object	remove(java.lang.String key) This method removes a value from the resource.
void	removeAll() This method releases all resources used by this instance.
void	removeSubset(java.lang.String prefix) This method removes a subset of values from the resource.
int	size() This method returns the number of elements in the resource

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH_INTERVAL_KEY

public static final java.lang.String REFRESH_INTERVAL_KEY

See Also:

Constant Field Values

DEFAULT_REFRESH_INTERVAL

public static final long DEFAULT_REFRESH_INTERVAL

See Also:

Constant Field Values

Method Detail

get

public java.lang.Object get(java.lang.String key)

Description copied from interface: BankFrameResource

This method gets a value.

Specified by:

get in interface BankFrameResource

Parameters:

key - The key for the value to get

Returns:

the value or null if the value is not found

See Also:

BankFrameResource.get(String)

getString

public java.lang.String getString(java.lang.String key)

Description copied from interface: BankFrameResource

This method gets a value.

Specified by:

getString in interface BankFrameResource

Parameters:

key - The key for the value to get

Returns:

the value or null if the value is not found

See Also:

BankFrameResource.getString(String)

getSubset

public BankFrameResource getSubset(java.lang.String prefix)

This method gets a subset of values whose keys all begin with the specified prefix.

Specified by:

getSubset in interface BankFrameResource

Parameters:

prefix - the prefix that the subset starts with

Returns:

a BankFrameResource instance

getUrl

public java.net.URL getUrl()

This method gets the URL for this resource.

Returns:

the URL for this resource

keys

public java.util.Enumeration keys()

The method gets all the keys in this cache

Specified by:

keys in interface BankFrameResource

Returns:

an enumeration of the keys

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Description copied from interface: BankFrameResource

This method adds a key/value to the resource. If the key already exists in the resource then this key is updated with the new value.

Specified by:

put in interface BankFrameResource

Parameters:

key - the name of the value

value - the value

See Also:

BankFrameResource.put(String, Object)

remove

public java.lang.Object remove(java.lang.String key)

Description copied from interface: BankFrameResource

This method removes a value from the resource.

Specified by:

remove in interface BankFrameResource

Parameters:

key - the name of the key to remove

See Also:

BankFrameResource.remove(String)

remove

public void remove(java.util.Enumeration keys)

Description copied from interface: BankFrameResource

This method removes keys from the resource.

Specified by:

remove in interface BankFrameResource

Parameters:

keys - an enumeration of the keys to remove

See Also:

BankFrameResource.remove(Enumeration)

removeAll

public void removeAll()

Description copied from interface: BankFrameResource

This method releases all resources used by this instance.

Specified by:

removeAll in interface BankFrameResource

See Also:

BankFrameResource.removeAll()

removeSubset

public void removeSubset(java.lang.String prefix)

Description copied from interface: BankFrameResource

This method removes a subset of values from the resource.

Specified by:

removeSubset in interface BankFrameResource

Parameters:

prefix - the prefix that the subset starts with

See Also:

BankFrameResource.removeSubset(String)

getLong

public java.lang.Long getLong(java.lang.String keyName)

Description copied from interface: BankFrameResource

This method gets the value of the specified property as a Long object.

Specified by:

getLong in interface BankFrameResource

Returns:

the value of the specifed property or null if a value does not exist

See Also:

BankFrameResource.getLong(String)

getInteger

public java.lang.Integer getInteger(java.lang.String keyName)

Description copied from interface: BankFrameResource

This method gets the value of the specified property as an Integer object.

Specified by:

getInteger in interface BankFrameResource

Returns:

the value of the specifed property or null if a value does not exist

See Also:

BankFrameResource.getInteger(String)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String keyName)

Description copied from interface: BankFrameResource

This method gets the value of the specified property as a Boolean value. If the value contains 'true' this method will return Boolean.TRUE, or Boolean.FALSE otherwise.

Specified by:

getBoolean in interface BankFrameResource

Returns:

the value of the specifed property or null if a value does not exist

See Also:

BankFrameResource.getBoolean(String)

getDouble

public java.lang.Double getDouble(java.lang.String keyName)

Description copied from interface: BankFrameResource

This method gets the value of the specified property as a Double object.

Specified by:

getDouble in interface BankFrameResource

Returns:

the value of the specifed property or null if a value does not exist

See Also:

BankFrameResource.getDouble(String)

size

public int size()

Description copied from interface: BankFrameResource

This method returns the number of elements in the resource

Specified by:

size in interface BankFrameResource

See Also:

BankFrameResource.size()

getDescription

public java.lang.String getDescription(java.lang.String key,
                                       java.util.Locale locale)

Description copied from interface: BankFrameResource

This method gets a textual description for the specified key (or subset) localised to the specified locale

Specified by:

getDescription in interface BankFrameResource

See Also:

BankFrameResource.getDescription(String, Locale)

getDescription

public java.lang.String getDescription(java.lang.String key)

Description copied from interface: BankFrameResource

This method gets a textual description for the specified key (or subset)

Specified by:

getDescription in interface BankFrameResource

See Also:

BankFrameResource.getDescription(String)