org.adroitlogic.x.base.format

Class ResourceAwareMessageFormat<T>

java.lang.Object

org.adroitlogic.x.base.format.ResourceAwareMessageFormat<T>

All Implemented Interfaces:

XMessageFormat<T>

public abstract class ResourceAwareMessageFormat<T>
extends Object
implements XMessageFormat<T>

Abstract implementation of XMessageFormat to support resource awareness for a payload format which gives the ability to clean up the underlying resources(e.g : file) at the end of the life cycle of attached XMessage

Since:

17.01

Author:

Sudheera Palihakkara

Constructor Summary

Constructors

Constructor and Description
ResourceAwareMessageFormat()

Method Summary

Modifier and Type	Method and Description
XMessageFormat<T>	copyOf() Clones the message format possibly cloning the payload within this format, if an implementation doesn't support cloning it is expected that particular implementation to throw an UnsupportedOperationException
protected abstract XMessageFormat<T>	getCopyOf() Actual implementation of copying should do in the implementation of this abstract method
boolean	isAttachedToAMessage()
void	markAsAttachedToaMessage() When invoked change attachedToAMessage value to true, This ensures releasing this XMessageFormat's resources has been delegated to the message lifecycle
protected abstract void	releaseBackingResource() Actual implementation of release resources should do in the implementation of this abstract method.
void	releaseResources() Used to clear the underlying resources when such cleaning needed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.x.api.XMessageFormat

readAsNative, readAsStream, readAsString, size, writeTo

Constructor Detail

ResourceAwareMessageFormat

public ResourceAwareMessageFormat()

Method Detail

markAsAttachedToaMessage

public void markAsAttachedToaMessage()

When invoked change attachedToAMessage value to true, This ensures releasing this XMessageFormat's resources has been delegated to the message lifecycle

Specified by:

markAsAttachedToaMessage in interface XMessageFormat<T>

copyOf

public final XMessageFormat<T> copyOf()

Clones the message format possibly cloning the payload within this format, if an implementation doesn't support cloning it is expected that particular implementation to throw an UnsupportedOperationException

Specified by:

copyOf in interface XMessageFormat<T>

Returns:

a cloned message format possibly with a cloned payload

releaseResources

public final void releaseResources()

Used to clear the underlying resources when such cleaning needed. It does not mean every time this method get invoked there is a resource cleaning involved. It depends on the implementation.

Specified by:

releaseResources in interface XMessageFormat<T>

getCopyOf

protected abstract XMessageFormat<T> getCopyOf()

Actual implementation of copying should do in the implementation of this abstract method

Returns:

a deep copy of this format

releaseBackingResource

protected abstract void releaseBackingResource()

Actual implementation of release resources should do in the implementation of this abstract method. Since this abstraction will handle all the copied Format's resource releasing, this implementation has to release only it's backing resource

isAttachedToAMessage

public boolean isAttachedToAMessage()