org.apache.tamaya.spisupport

Class BasePropertySource

java.lang.Object

org.apache.tamaya.spisupport.BasePropertySource

All Implemented Interfaces:

org.apache.tamaya.spi.PropertySource

Direct Known Subclasses:

CLIPropertySource, EnvironmentPropertySource, MapPropertySource, SimplePropertySource, SystemPropertySource

public abstract class BasePropertySource
extends Object
implements org.apache.tamaya.spi.PropertySource

Abstract PropertySource that allows to set a default ordinal that will be used, if no ordinal is provided with the config.

Field Summary

Fields inherited from interface org.apache.tamaya.spi.PropertySource

EMPTY, TAMAYA_ORDINAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePropertySource() Constructor, using a default ordinal of 0.
protected	BasePropertySource(int defaultOrdinal) Constructor.
protected	BasePropertySource(String name) Constructor.
protected	BasePropertySource(String name, int defaultOrdinal) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.tamaya.spi.PropertyValue	get(String key)
int	getDefaultOrdinal() Returns the default ordinal used, when no ordinal is set, or the ordinal was not parseable to an int value.
String	getName()
int	getOrdinal()
boolean	isScannable()
void	setDefaultOrdinal(Integer defaultOrdinal) Allows to set the ordinal of this property source explcitly.
void	setName(String name) Sets the property source's (unique) name.
void	setOrdinal(Integer ordinal) Allows to set the ordinal of this property source explcitly.
String	toString()
protected String	toStringValues()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tamaya.spi.PropertySource

getProperties

Constructor Detail

BasePropertySource

protected BasePropertySource(String name)

Constructor.

Parameters:

name - the (unique) property source name, not null.

BasePropertySource

protected BasePropertySource(int defaultOrdinal)

Constructor.

Parameters:

defaultOrdinal - default ordinal that will be used, if no ordinal is provided with the config.

BasePropertySource

protected BasePropertySource(String name,
                             int defaultOrdinal)

Constructor.

Parameters:

name - the (unique) property source name, not null.

defaultOrdinal - default ordinal that will be used, if no ordinal is provided with the config.

BasePropertySource

protected BasePropertySource()

Constructor, using a default ordinal of 0.

Method Detail

getName

public String getName()

Specified by:

getName in interface org.apache.tamaya.spi.PropertySource

setName

public void setName(String name)

Sets the property source's (unique) name.

Parameters:

name - the name, not null.

setOrdinal

public void setOrdinal(Integer ordinal)

Allows to set the ordinal of this property source explcitly. This will override any evaluated ordinal, or default ordinal. To reset an explcit ordinal call setOrdinal(null);.

Parameters:

ordinal - the explicit ordinal, or null.

setDefaultOrdinal

public void setDefaultOrdinal(Integer defaultOrdinal)

Allows to set the ordinal of this property source explcitly. This will override any evaluated ordinal, or default ordinal. To reset an explcit ordinal call setOrdinal(null);.

Parameters:

defaultOrdinal - the default ordinal, or null.

getOrdinal

public int getOrdinal()

Specified by:

getOrdinal in interface org.apache.tamaya.spi.PropertySource

getDefaultOrdinal

public int getDefaultOrdinal()

Returns the default ordinal used, when no ordinal is set, or the ordinal was not parseable to an int value.

Returns:

the default ordinal used, by default 0.

get

public org.apache.tamaya.spi.PropertyValue get(String key)

Specified by:

get in interface org.apache.tamaya.spi.PropertySource

isScannable

public boolean isScannable()

Specified by:

isScannable in interface org.apache.tamaya.spi.PropertySource

toString

public String toString()

Overrides:

toString in class Object

toStringValues

protected String toStringValues()