de.intarsys.tools.attachment

Class AttachmentTools

java.lang.Object

de.intarsys.tools.attachment.AttachmentTools

public class AttachmentTools
extends Object

A tool class for implementing a generic attachment feature.

Attachments can be made for an object or a thread context.

Constructor Summary

Constructors

Constructor and Description
AttachmentTools()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAttachment(Attachment attachment) Add a Attachment to the thread context.
static void	addAttachment(String key, Object value) Add a Attachment to the thread context.
static void	addAttachments(Attachment[] pAttachments) Add an array of Attachment instances to the thread context.
static void	addAttachments(List<Attachment> pAttachments) Add a list of Attachment instances to the thread context.
static void	attach()
static void	clearAttachments() Clear all attachments for the thread context.
static void	detach()
static Attachment	getAttachment(String key) Get the first Attachment matching "key" in the thread context.
static Attachment[]	getAttachments() Get all Attachment instances for the thread context.
static Attachment[]	getAttachments(String key) Get all attachments matching "key" in the thread context.
static boolean	hasAttachment(String key) true if the thread context has an attachment for "key"
static boolean	removeAttached(Object attached) Remove attachment with attached object in the thread context.
static boolean	removeAttachment(Attachment pAttachment) Remove attachment in the thread context.
static void	removeAttachments(String key) Remove all attachments for key in the thread context.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentTools

public AttachmentTools()

Method Detail

addAttachment

public static void addAttachment(Attachment attachment)

Add a Attachment to the thread context.

Parameters:

attachment - The new attachment

addAttachment

public static void addAttachment(String key,
                 Object value)

Add a Attachment to the thread context.

Parameters:

key - The key

value - The attached object

addAttachments

public static void addAttachments(Attachment[] pAttachments)

Add an array of Attachment instances to the thread context.

Parameters:

pAttachments -

addAttachments

public static void addAttachments(List<Attachment> pAttachments)

Add a list of Attachment instances to the thread context.

Parameters:

pAttachments -

attach

public static void attach()

clearAttachments

public static void clearAttachments()

Clear all attachments for the thread context.

detach

public static void detach()

getAttachment

public static Attachment getAttachment(String key)

Get the first Attachment matching "key" in the thread context.

Parameters:

key - The key value that is searched

Returns:

The first matching Attachment or null

getAttachments

public static Attachment[] getAttachments()

Get all Attachment instances for the thread context.

Returns:

Get all attachments for the thread context.

getAttachments

public static Attachment[] getAttachments(String key)

Get all attachments matching "key" in the thread context.

Parameters:

key - The key value that is searched

Returns:

All matching attachments

hasAttachment

public static boolean hasAttachment(String key)

true if the thread context has an attachment for "key"

Parameters:

key - The key value that is searched

Returns:

true if object has an attachment for "key"

removeAttached

public static boolean removeAttached(Object attached)

Remove attachment with attached object in the thread context.

Parameters:

attached -

Returns:

true if removed

removeAttachment

public static boolean removeAttachment(Attachment pAttachment)

Remove attachment in the thread context.

Parameters:

pAttachment -

Returns:

true if removed

removeAttachments

public static void removeAttachments(String key)

Remove all attachments for key in the thread context.

Parameters:

key - The key value for the attachments to be removed