Package org.jboss.as.server.deployment
Interface Attachable
-
- All Known Subinterfaces:
DeploymentPhaseContext,DeploymentUnit
- All Known Implementing Classes:
AdditionalModuleSpecification,ModuleSpecification,ResourceRoot,SimpleAttachable
public interface AttachableAn entity which can contain attachments.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <T> voidaddToAttachmentList(AttachmentKey<AttachmentList<T>> key, T value)Add a value to a list-typed attachment key.<T> TgetAttachment(AttachmentKey<T> key)Get an attachment value.<T> List<T>getAttachmentList(AttachmentKey<? extends List<T>> key)Gets a list attachment value.booleanhasAttachment(AttachmentKey<?> key)Check if an attachment exists for this key.<T> TputAttachment(AttachmentKey<T> key, T value)Set an attachment value.<T> TremoveAttachment(AttachmentKey<T> key)Remove an attachment, returning its previous value.
-
-
-
Method Detail
-
hasAttachment
boolean hasAttachment(AttachmentKey<?> key)
Check if an attachment exists for this key.- Parameters:
key- the attachment key- Returns:
falseif there is none
-
getAttachment
<T> T getAttachment(AttachmentKey<T> key)
Get an attachment value. If no attachment exists for this key,nullis returned.- Type Parameters:
T- the value type- Parameters:
key- the attachment key- Returns:
- the value, or
nullif there is none
-
getAttachmentList
<T> List<T> getAttachmentList(AttachmentKey<? extends List<T>> key)
Gets a list attachment value. If not attachment exists for this key an empty list is returned- Type Parameters:
T- the value type- Parameters:
key- the attachment key- Returns:
- the value, or an empty list if there is none
-
putAttachment
<T> T putAttachment(AttachmentKey<T> key, T value)
Set an attachment value. If an attachment for this key was already set, return the original value. If the value being set isnull, the attachment key is removed.- Type Parameters:
T- the value type- Parameters:
key- the attachment keyvalue- the new value- Returns:
- the old value, or
nullif there was none
-
removeAttachment
<T> T removeAttachment(AttachmentKey<T> key)
Remove an attachment, returning its previous value.- Type Parameters:
T- the value type- Parameters:
key- the attachment key- Returns:
- the old value, or
nullif there was none
-
addToAttachmentList
<T> void addToAttachmentList(AttachmentKey<AttachmentList<T>> key, T value)
Add a value to a list-typed attachment key. If the key is not mapped, add such a mapping.- Type Parameters:
T- the list value type- Parameters:
key- the attachment keyvalue- the value to add
-
-