ValueHolder (EclipseLink 2.6.8, API Reference)

java.lang.Object
- org.eclipse.persistence.indirection.ValueHolder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ValueHolderInterface, WeavedAttributeValueHolderInterface
```
public class ValueHolder
extends java.lang.Object
implements WeavedAttributeValueHolderInterface, java.lang.Cloneable, java.io.Serializable
```
Purpose: Act as a place holder for a variable that required a value holder interface. This class should be used to initialze an objects attributes that are using indirection is their mappings.

See Also:
Serialized Form

Property Summary

Properties
Type	Property and Description
`boolean`	`isCoordinatedWith` Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Object value
Stores the wrapped object.
- Fields inherited from interface org.eclipse.persistence.indirection.ValueHolderInterface
  shouldToStringInstantiate

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`value` Stores the wrapped object.

Constructor Summary

Constructors
Constructor and Description

ValueHolder()
PUBLIC: Initialize the holder.

ValueHolder(java.lang.Object value)
PUBLIC: Initialize the holder with an object.

Constructors
Constructor and Description
`ValueHolder()` PUBLIC: Initialize the holder.
`ValueHolder(java.lang.Object value)` PUBLIC: Initialize the holder with an object.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` INTERNAL:
`java.lang.Object`	`getValue()` PUBLIC: Return the wrapped object.
`boolean`	`isCoordinatedWithProperty()` Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property
`boolean`	`isInstantiated()` PUBLIC: Return a boolean indicating whether the wrapped object has been set or not.
`boolean`	`isNewlyWeavedValueHolder()` Used as part of the implementation of WeavedAttributeValueHolderInterface Used to determine if this ValueHolder was added instantiated as part of the constructor of a weaved class
`void`	`setIsCoordinatedWithProperty(boolean coordinated)` Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property This method will be called internall when the state of Coordination between the weaved valueholder and the underlying value is known
`void`	`setIsNewlyWeavedValueHolder(boolean isNew)` Used as part of the implementation of WeavedAttributeValueHolderInterface Used to determine if this ValueHolder was added instantiated as part of the constructor of a weaved class This method will be called when a ValueHolder is instantiated in a weaved class
`void`	`setValue(java.lang.Object value)` PUBLIC: Set the wrapped object.
`boolean`	`shouldAllowInstantiationDeferral()` INTERNAL: Return if add/remove should trigger instantiation or avoid.
`java.lang.String`	`toString()` INTERNAL:

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - isCoordinatedWith
    
    Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property
    
    Specified by:
    
    isCoordinatedWithProperty in interface WeavedAttributeValueHolderInterface
    
    Returns:
- Field Detail
  - value
```
protected java.lang.Object value
```
    Stores the wrapped object.
- Constructor Detail
  - ValueHolder
```
public ValueHolder()
```
    PUBLIC: Initialize the holder.
  - ValueHolder
```
public ValueHolder(java.lang.Object value)
```
    PUBLIC: Initialize the holder with an object.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    INTERNAL:
    
    Specified by:
    
    clone in interface ValueHolderInterface
    
    Overrides:
    
    clone in class java.lang.Object
  - getValue
```
public java.lang.Object getValue()
```
    PUBLIC: Return the wrapped object.
    
    Specified by:
    
    getValue in interface ValueHolderInterface
  - isCoordinatedWithProperty
```
public boolean isCoordinatedWithProperty()
```
    Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property
    
    Specified by:
    
    isCoordinatedWithProperty in interface WeavedAttributeValueHolderInterface
    
    Returns:
  - isNewlyWeavedValueHolder
```
public boolean isNewlyWeavedValueHolder()
```
    Used as part of the implementation of WeavedAttributeValueHolderInterface Used to determine if this ValueHolder was added instantiated as part of the constructor of a weaved class
    
    Specified by:
    
    isNewlyWeavedValueHolder in interface WeavedAttributeValueHolderInterface
    
    Returns:
  - isInstantiated
```
public boolean isInstantiated()
```
    PUBLIC: Return a boolean indicating whether the wrapped object has been set or not.
    
    Specified by:
    
    isInstantiated in interface ValueHolderInterface
  - setIsCoordinatedWithProperty
```
public void setIsCoordinatedWithProperty(boolean coordinated)
```
    Used as part of the implementation of WeavedAttributeValueHolderInterface Used to track whether a valueholder that has been weaved into a class is coordinated with the underlying property This method will be called internall when the state of Coordination between the weaved valueholder and the underlying value is known
    
    Specified by:
    
    setIsCoordinatedWithProperty in interface WeavedAttributeValueHolderInterface
  - setIsNewlyWeavedValueHolder
```
public void setIsNewlyWeavedValueHolder(boolean isNew)
```
    Used as part of the implementation of WeavedAttributeValueHolderInterface Used to determine if this ValueHolder was added instantiated as part of the constructor of a weaved class This method will be called when a ValueHolder is instantiated in a weaved class
    
    Specified by:
    
    setIsNewlyWeavedValueHolder in interface WeavedAttributeValueHolderInterface
  - setValue
```
public void setValue(java.lang.Object value)
```
    PUBLIC: Set the wrapped object.
    
    Specified by:
    
    setValue in interface ValueHolderInterface
  - shouldAllowInstantiationDeferral
```
public boolean shouldAllowInstantiationDeferral()
```
    INTERNAL: Return if add/remove should trigger instantiation or avoid. Current instantiation is avoided is using change tracking.
    
    Specified by:
    
    shouldAllowInstantiationDeferral in interface WeavedAttributeValueHolderInterface
  - toString
```
public java.lang.String toString()
```
    INTERNAL:
    
    Overrides:
    
    toString in class java.lang.Object

Class ValueHolder

Property Summary

Field Summary

Fields inherited from interface org.eclipse.persistence.indirection.ValueHolderInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

isCoordinatedWith

Field Detail

value

Constructor Detail

ValueHolder

ValueHolder

Method Detail

clone

getValue

isCoordinatedWithProperty

isNewlyWeavedValueHolder

isInstantiated

setIsCoordinatedWithProperty

setIsNewlyWeavedValueHolder

setValue

shouldAllowInstantiationDeferral

toString