org.apache.tamaya.spisupport

Class EnvironmentPropertySource

java.lang.Object

org.apache.tamaya.spisupport.BasePropertySource

org.apache.tamaya.spisupport.EnvironmentPropertySource

All Implemented Interfaces:

org.apache.tamaya.spi.PropertySource

public class EnvironmentPropertySource
extends BasePropertySource

This PropertySource provides all Properties which are set via export myprop=myval on UNIX Systems or set myprop=myval on Windows. You can disable this feature by setting tamaya.envprops.disable or tamaya.defaults.disable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDINAL Default ordinal used.

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

EMPTY, TAMAYA_ORDINAL

Constructor Summary

Constructors

Constructor and Description
EnvironmentPropertySource() Creates a new instance.
EnvironmentPropertySource(int ordinal) Creates a new instance using a fixed ordinal value.
EnvironmentPropertySource(String prefix) Creates a new instance.
EnvironmentPropertySource(String prefix, int ordinal) Creates a new instance.

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()
Map<String,org.apache.tamaya.spi.PropertyValue>	getProperties()
boolean	isScannable()
protected String	toStringValues()

Methods inherited from class org.apache.tamaya.spisupport.BasePropertySource

getOrdinal, setDefaultOrdinal, setName, setOrdinal, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDINAL

public static final int DEFAULT_ORDINAL

Default ordinal used.

See Also:

Constant Field Values

Constructor Detail

EnvironmentPropertySource

public EnvironmentPropertySource()

Creates a new instance. Also initializes the prefix and disabled properties from the system-/ environment properties:

     tamaya.envprops.prefix
     tamaya.envprops.disable
 

EnvironmentPropertySource

public EnvironmentPropertySource(int ordinal)

Creates a new instance using a fixed ordinal value.

Parameters:

ordinal - the ordinal number.

EnvironmentPropertySource

public EnvironmentPropertySource(String prefix,
                                 int ordinal)

Creates a new instance.

Parameters:

prefix - the prefix to be used, or null.

ordinal - the ordinal to be used.

EnvironmentPropertySource

public EnvironmentPropertySource(String prefix)

Creates a new instance.

Parameters:

prefix - the prefix to be used, or null.

Method Detail

getDefaultOrdinal

public int getDefaultOrdinal()

Description copied from class: BasePropertySource

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

Overrides:

getDefaultOrdinal in class BasePropertySource

Returns:

the default ordinal used, by default 0.

getName

public String getName()

Specified by:

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

Overrides:

getName in class BasePropertySource

get

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

Specified by:

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

Overrides:

get in class BasePropertySource

getProperties

public Map<String,org.apache.tamaya.spi.PropertyValue> getProperties()

isScannable

public boolean isScannable()

Specified by:

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

Overrides:

isScannable in class BasePropertySource

toStringValues

protected String toStringValues()

Overrides:

toStringValues in class BasePropertySource