net.sf.cuf.xfer

Class AbstractRequest

java.lang.Object

net.sf.cuf.xfer.AbstractRequest

All Implemented Interfaces:

Request

public abstract class AbstractRequest
extends Object
implements Request

This class provides the common stuff of all Request classes. It provides delegate and dispatch target handling. In most cases, a derived class must only implement the execute() method.

Constructor Summary

Constructors

Constructor and Description
AbstractRequest() Derived classes must call this constructor via super() if they want to get the benefit of delegate handling.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeCancelled() A request object may be canceled if this method returns true.
void	cancel() Cancel the current request; this implementation will always throw an IllegalStateException.
boolean	equals(Object pOther) A AbstractRequest is equal to an other AbstractRequest if their delegates and dispatch targets are equal.
RequestDelegate	getDelegate() Returns our request delegate.
DispatchTarget	getDispatchTarget() Returns our dispatch target.
int	hashCode()
void	setDispatchTarget(DispatchTarget pTarget) Sets our dispatch target.
void	setDispatchTarget(Object pTargetObject, String pMethodName) Sets our dispatch target.
String	toString() Returns a String representation of this AbstractRequest.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.cuf.xfer.Request

execute

Constructor Detail

AbstractRequest

public AbstractRequest()

Derived classes must call this constructor via super() if they want to get the benefit of delegate handling.

Method Detail

setDispatchTarget

public void setDispatchTarget(DispatchTarget pTarget)

Sets our dispatch target.

Specified by:

setDispatchTarget in interface Request

Parameters:

pTarget - the target to set (null is o.k.)

setDispatchTarget

public void setDispatchTarget(Object pTargetObject,
                     String pMethodName)

Sets our dispatch target.

Specified by:

setDispatchTarget in interface Request

Parameters:

pTargetObject - target to call, must not be null

pMethodName - method to call, must not be null and match the void (Response pResponse) signature

getDispatchTarget

public DispatchTarget getDispatchTarget()

Returns our dispatch target.

Specified by:

getDispatchTarget in interface Request

Returns:

dispatch target (may be null)

getDelegate

public RequestDelegate getDelegate()

Returns our request delegate.

Specified by:

getDelegate in interface Request

Returns:

request delegate (may be null)

canBeCancelled

public boolean canBeCancelled()

A request object may be canceled if this method returns true.

Specified by:

canBeCancelled in interface Request

Returns:

always false

cancel

public void cancel()
            throws IllegalStateException

Cancel the current request; this implementation will always throw an IllegalStateException.

Specified by:

cancel in interface Request

Throws:

IllegalStateException - always thrown

equals

public boolean equals(Object pOther)

A AbstractRequest is equal to an other AbstractRequest if their delegates and dispatch targets are equal.

Overrides:

equals in class Object

Parameters:

pOther - object we compare to

Returns:

true if the objects are equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a String representation of this AbstractRequest.

Overrides:

toString in class Object

Returns:

a String representation of this AbstractRequest.