Package com.xebialabs.deployit.plugin.api.udm

Class Dictionary

java.lang.Object

com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

com.xebialabs.deployit.plugin.api.udm.AbstractDictionary

com.xebialabs.deployit.plugin.api.udm.Dictionary

All Implemented Interfaces:

ConfigurationItem, IDictionary, IEncryptedDictionary, java.io.Serializable, java.lang.Comparable<BaseConfigurationItem>

Direct Known Subclasses:

EncryptedDictionary

@Metadata(root=ENVIRONMENTS,
          description="A Dictionary contains key-value pairs that can be replaced")
@TypeIcon("icons/types/udm.Dictionary.svg")
public class Dictionary
extends AbstractDictionary
implements IEncryptedDictionary

A Dictionary is a CI that contains Environment-specific entries for placeholder resolution. A dictionary value can refer to another dictionary entry. This is accomplished by using the {{..}} placeholder syntax. For example: MESSAGE Welcome to {{APP_NAME}}!

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.xebialabs.deployit.plugin.api.udm.IDictionary

IDictionary.DictionaryContext

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

id, syntheticProperties, type

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Constructor Summary

Constructors

Constructor	Description
Dictionary()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getEncryptedEntries()
java.util.Map<java.lang.String,java.lang.String>	getEntries()
java.util.Set<Application>	getRestrictToDistributions()
java.lang.String	getValue(java.lang.String key)
boolean	hasValue(java.lang.String key)
void	setEncryptedEntries(java.util.Map<java.lang.String,java.lang.String> encryptedEntries)
void	setEntries(java.util.Map<java.lang.String,java.lang.String> dict)

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.AbstractDictionary

applyTo, getRestrictToApplications, getRestrictToContainers

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

compareTo, equals, get$ciAttributes, get$externalProperties, get$internalId, get$securedCi, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$externalProperties, set$internalId, set$securedCi, set$token, set$validationMessages, setId, setProperty, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

get$internalId, get$securedCi, get$validationMessages, getId, getName, getProperty, getType, hasProperty, setId, setProperty

Methods inherited from interface com.xebialabs.deployit.plugin.api.udm.IDictionary

applyTo

Constructor Detail

Dictionary

public Dictionary()

Method Detail

setEntries

public void setEntries(java.util.Map<java.lang.String,java.lang.String> dict)

Parameters:

dict - The dictionary entries.

getEntries

public java.util.Map<java.lang.String,java.lang.String> getEntries()

Specified by:

getEntries in interface IDictionary

Returns:

The dictionary entries.

getEncryptedEntries

public java.util.Map<java.lang.String,java.lang.String> getEncryptedEntries()

Specified by:

getEncryptedEntries in interface IEncryptedDictionary

Returns:

The encrypted dictionary entries

setEncryptedEntries

public void setEncryptedEntries(java.util.Map<java.lang.String,java.lang.String> encryptedEntries)

Parameters:

encryptedEntries - The encrypted dictionary entries

getValue

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

Specified by:

getValue in interface IDictionary

Parameters:

key - The key of a dictionary entry.

Returns:

The value associated with the given key.

hasValue

public boolean hasValue(java.lang.String key)

Parameters:

key - The key of a dictionary entry.

Returns:

Whether the dictionary contains the given key.

getRestrictToDistributions

public java.util.Set<Application> getRestrictToDistributions()

Returns:

The set of Applications only for which the dictionary is applied.