Attachment (OpenDJ Server NG 4.4.12 API)

java.lang.Object
- org.forgerock.opendj.server.core.Attachment<T>

Type Parameters:

T - The type of attachment.
```
public final class Attachment<T>
extends Object
```
Class used to define dynamic typed attachments on AttachmentHolder instances. Storing attachment values in AttachmentHolder has the advantage of the Attachment value being typed when compared to Map storage:

Constructor Summary

Constructors
Constructor Description

Attachment(String name, T defaultValue)
Construct a new attachment with the specified name and default value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`get(AttachmentHolder attachmentHolder)`	Retrieves the attachment value, stored on the `AttachmentHolder`.
`T`	`remove(AttachmentHolder attachmentHolder)`	Remove attachment value, stored on the `AttachmentHolder`.
`T`	`set(AttachmentHolder attachmentHolder, T value)`	Set attachment value, stored on the `AttachmentHolder`.

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

- Constructor Detail
  - Attachment
```
public Attachment(String name,
                  T defaultValue)
```
    Construct a new attachment with the specified name and default value.
    
    Parameters:
    
    name - Attachment name.
    
    defaultValue - Attachment default value, which will be used, if it is not set.
- Method Detail
  - get
```
public T get(AttachmentHolder attachmentHolder)
```
    Retrieves the attachment value, stored on the AttachmentHolder.
    
    Parameters:
    
    attachmentHolder - AttachmentHolder.
    
    Returns:
    
    attachment value.
  - remove
```
public T remove(AttachmentHolder attachmentHolder)
```
    Remove attachment value, stored on the AttachmentHolder.
    
    Parameters:
    
    attachmentHolder - AttachmentHolder.
    
    Returns:
    
    The former value or null if there was previously no value.
  - set
```
public T set(AttachmentHolder attachmentHolder,
             T value)
```
    Set attachment value, stored on the AttachmentHolder. If a value already exists, it will be replaced.
    
    Parameters:
    
    attachmentHolder - AttachmentHolder.
    
    value - attachment value to set.
    
    Returns:
    
    The former value or null if there was previously no value.