oracle.oud.plugin

Interface AttachmentHolder

All Known Subinterfaces:

AddRequest, BindRequest, CompareRequest, DeleteRequest, ExtendedRequest<R>, ModifyDNRequest, ModifyRequest, Request, SearchRequest

All Known Implementing Classes:

AddRequestWrapper, BindRequestWrapper, CompareRequestWrapper, DeleteRequestWrapper, ExtendedRequestWrapper, ModifyDNRequestWrapper, ModifyRequestWrapper, SearchRequestWrapper

public interface AttachmentHolder

This interface defines how objects can be attached, retrieved and removed to and from various entities.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttachment(java.lang.String name) Retrieves the attachment with the specified name.
java.util.Set<java.lang.String>	getAttachmentNames() Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.
java.lang.Object	removeAttachment(java.lang.String name) Removes the attachment with the specified name.
java.lang.Object	setAttachment(java.lang.String name, java.lang.Object value) Sets the value of the specified attachment.

Method Detail

removeAttachment

java.lang.Object removeAttachment(java.lang.String name)

Removes the attachment with the specified name.

Parameters:

name - The name for the attachment to remove. It will be treated in a case-sensitive manner.

Returns:

The attachment that was removed, or null if it does not exist.

setAttachment

java.lang.Object setAttachment(java.lang.String name,
                               java.lang.Object value)

Sets the value of the specified attachment. If an attachment already exists with the same name, it will be replaced. Otherwise, a new attachment will be added.

Parameters:

name - The name to use for the attachment.

value - The value to use for the attachment.

Returns:

The former value held by the attachment with the given name, or null if there was previously no such attachment.

getAttachment

java.lang.Object getAttachment(java.lang.String name)

Retrieves the attachment with the specified name.

Parameters:

name - The name for the attachment to retrieve. It will be treated in a case-sensitive manner.

Returns:

The requested attachment object, or null if it does not exist.

getAttachmentNames

java.util.Set<java.lang.String> getAttachmentNames()

Retrieves the set of attachment names defined for this holder, as a mapping between the attachment name and the associated object.

Returns:

The set of attachments defined for this request.