org.jvnet.hk2.config

Interface ConfigBeanProxyCustomizer

@Contract
public interface ConfigBeanProxyCustomizer

Author:

jwells

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_IMPLEMENTATION

Method Summary

Methods

Modifier and Type	Method and Description
ConfigBeanProxy	createChild(ConfigBeanProxy me, Class<?> type) Creates a child element of this configuration element
ConfigBeanProxy	deepCopy(ConfigBeanProxy me, ConfigBeanProxy parent) Performs a deep copy of this configuration element and returns it.
ConfigBeanProxy	getParent(ConfigBeanProxy me) Returns the parent element of this configuration element.
ConfigBeanProxy	getParent(ConfigBeanProxy me, Class<?> type) Returns the typed parent element of this configuration element.

Field Detail

DEFAULT_IMPLEMENTATION

static final String DEFAULT_IMPLEMENTATION

See Also:

Constant Field Values

Method Detail

getParent

ConfigBeanProxy getParent(ConfigBeanProxy me)

Returns the parent element of this configuration element. It is possible to return a not null parent while the parent knows nothing of this child element. This could happen when the child element was removed from the configuration tree, yet it's parent would not have been reset.

Returns:

the parent configuration node.

getParent

ConfigBeanProxy getParent(ConfigBeanProxy me,
                        Class<?> type)

Returns the typed parent element of this configuration element. It is possible to return a not null parent while the parent knows nothing of this child element. This could happen when the child element was removed from the configuration tree, yet it's parent would not have been reset.

Parameters:

type - parent's type

Returns:

the parent configuration node.

createChild

ConfigBeanProxy createChild(ConfigBeanProxy me,
                          Class<?> type)

Creates a child element of this configuration element

Parameters:

type - the child element type

Returns:

the newly created child instance

Throws:

TransactionFailure - when called outside the boundaries of a transaction

deepCopy

ConfigBeanProxy deepCopy(ConfigBeanProxy me,
                       ConfigBeanProxy parent)

Performs a deep copy of this configuration element and returns it. The parent of this configuration must be locked in a transaction and the newly created child will be automatically enrolled in the parent's transaction.

Parameters:

parent - the writable copy of the parent

Returns:

a deep copy of itself.

Throws:

TransactionFailure - if the transaction cannot be completed.