Module org.refcodes.properties

Package org.refcodes.properties

Class ProfilePropertiesProjection

java.lang.Object

org.refcodes.properties.ProfilePropertiesProjection

All Implemented Interfaces:

org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<String>, Properties, org.refcodes.struct.CanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.Dictionary<String,String>, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.struct.PathMap<String>

public class ProfilePropertiesProjection
extends Object
implements Properties

The ProfilePropertiesProjection applies the profiles as of ProfileProperties.getRuntimeProfiles() onto the encapsulated Properties (ProfileProperties) and provides a view of them Properties (ProfileProperties) from the profiles' point of view e.g. as when profiles have been applied to them Properties (ProfileProperties). In other words, the profiles are resolved and the result is provided as view: Under the hood, the provided Properties are decorated with a ProfilePropertiesDecorator which then is used to provide the profile projection via ProfileProperties.toRuntimeProfile().

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.CanonicalMap

org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary

org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.mixin.EmptyAccessor

org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.PathMap

org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.properties.Properties

Properties.MutableProperties, Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Fields inherited from interface org.refcodes.properties.Properties

DEFAULT_COMMENT

Constructor Summary

Constructors

Constructor	Description
ProfilePropertiesProjection(ProfileProperties aProperties)	Uses the ProfileProperties for the profile projection.
ProfilePropertiesProjection(ProfileProperties aProperties, String... aProfiles)	Uses the ProfileProperties for the profile projection.
ProfilePropertiesProjection(Properties.PropertiesBuilder aProperties, String... aProfiles)	Wraps the Properties.PropertiesBuilder with a profile projection.
ProfilePropertiesProjection(Properties aProperties, String... aProfiles)	Wraps the Properties with a profile projection.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object aKey)
String	get(Object aKey)
char	getDelimiter()	Returns the default path delimiter as of Delimiter.PATH.
boolean	isEmpty()
Set<String>	keySet()
Properties	retrieveFrom(String aFromPath)
Properties	retrieveTo(String aToPath)
int	size()
Object	toDataStructure(String aFromPath)
Collection<String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.struct.CanonicalMap

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump, toPrintable

Methods inherited from interface org.refcodes.struct.InterOperableMap

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface org.refcodes.struct.Keys

getOr, use

Methods inherited from interface org.refcodes.struct.PathMap

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

Methods inherited from interface org.refcodes.properties.Properties

containsValue, getAnnotator, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getType, query, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo

Constructor Detail

ProfilePropertiesProjection

public ProfilePropertiesProjection(Properties aProperties,
                                   String... aProfiles)

Wraps the Properties with a profile projection. The Properties are decorated with a ProfilePropertiesDecorator which provides the projected Properties from the wrapped Properties with the given profiles applied. See also ProfileProperties.toRuntimeProfile(String...).

Parameters:

aProperties - The properties which are to be projected according to the provided profiles. The evaluation is done as of ProfileProperties.toRuntimeProfile(String...).

aProfiles - The profiles to be used when constructing the projection.

ProfilePropertiesProjection

public ProfilePropertiesProjection(Properties.PropertiesBuilder aProperties,
                                   String... aProfiles)

Wraps the Properties.PropertiesBuilder with a profile projection. The Properties.PropertiesBuilder are decorated with a ProfilePropertiesDecorator which then is used to provide the profile projection via ProfileProperties.toRuntimeProfile(String...) using the provided profiles

Parameters:

aProperties - The properties which are to be projected according to the therein set profiles. The evaluation is done as of ProfileProperties.toRuntimeProfile(String...).

aProfiles - The profiles to be used when constructing the projection.

ProfilePropertiesProjection

public ProfilePropertiesProjection(ProfileProperties aProperties)

Uses the ProfileProperties for the profile projection. The ProfileProperties provide the profile projection via ProfileProperties.toRuntimeProfile().

Parameters:

aProperties - The properties which provide the according profile projections applying the therein set profiles. The evaluation is done as of ProfileProperties.toRuntimeProfile(String...).

ProfilePropertiesProjection

public ProfilePropertiesProjection(ProfileProperties aProperties,
                                   String... aProfiles)

Uses the ProfileProperties for the profile projection. The ProfileProperties provide the profile projection via ProfileProperties.toRuntimeProfile(String...) using the provided profiles

Parameters:

aProperties - The properties which are to be projected according to the therein set profiles. The evaluation is done as of ProfileProperties.toRuntimeProfile(String...).

aProfiles - The profiles to be used when constructing the projection.

Method Detail

getDelimiter

public char getDelimiter()

Returns the default path delimiter as of Delimiter.PATH.

Specified by:

getDelimiter in interface org.refcodes.mixin.DelimiterAccessor

Specified by:

getDelimiter in interface Properties

size

public int size()

Specified by:

size in interface org.refcodes.struct.Containable

containsKey

public boolean containsKey(Object aKey)

Specified by:

containsKey in interface org.refcodes.struct.Keys<String,String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.refcodes.mixin.EmptyAccessor

get

public String get(Object aKey)

Specified by:

get in interface org.refcodes.struct.Keys<String,String>

keySet

public Set<String> keySet()

Specified by:

keySet in interface org.refcodes.struct.Keys<String,String>

values

public Collection<String> values()

Specified by:

values in interface org.refcodes.struct.Keys<String,String>

retrieveFrom

public Properties retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveFrom in interface org.refcodes.struct.PathMap<String>

Specified by:

retrieveFrom in interface Properties

retrieveTo

public Properties retrieveTo(String aToPath)

Specified by:

retrieveTo in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveTo in interface org.refcodes.struct.PathMap<String>

Specified by:

retrieveTo in interface Properties

toDataStructure

public Object toDataStructure(String aFromPath)

Specified by:

toDataStructure in interface org.refcodes.struct.PathMap<String>