com.goldencode.p2j.util

Class ExternalResource

java.lang.Object

com.goldencode.p2j.util.ExternalResource

All Implemented Interfaces:

Deletable, WrappedResource, java.io.Externalizable, java.io.Serializable

public class ExternalResource
extends java.lang.Object
implements Deletable, WrappedResource, java.io.Externalizable

Instances of this class are helpers to associate a surrogate handle ID with a resource on a remote side. Useful for i.e. SUBSCRIBE/UNSUBSCRIBE/PUBLISH APIs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Long	id The resource ID.

Constructor Summary

Constructors

Constructor and Description
ExternalResource()

Method Summary

Modifier and Type	Method and Description
void	delete() Perform actual delete of an resource.
boolean	equals(java.lang.Object obj) Check if this instance equals the given one.
int	hashCode() Compute the hashcode of this instance.
java.lang.Long	id() Get this resource's ID.
void	id(long id) Set this resource's ID.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
boolean	unknown() Reports if this object is unknown.
boolean	valid() Reports if this object is valid for use.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

id

private java.lang.Long id

The resource ID.

Constructor Detail

ExternalResource

public ExternalResource()

Method Detail

valid

public boolean valid()

Reports if this object is valid for use.

Specified by:

valid in interface WrappedResource

Returns:

Always true.

unknown

public boolean unknown()

Reports if this object is unknown.

Specified by:

unknown in interface WrappedResource

Returns:

Always false.

id

public java.lang.Long id()

Get this resource's ID.

Specified by:

id in interface WrappedResource

Returns:

See above.

id

public void id(long id)

Set this resource's ID.

Specified by:

id in interface WrappedResource

Parameters:

id - The resource's ID.

delete

public void delete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

Specified by:

delete in interface Deletable

equals

public boolean equals(java.lang.Object obj)

Check if this instance equals the given one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to check.

Returns:

true if obj is a ExternalResource and its id is the same as the one in this instance.

hashCode

public int hashCode()

Compute the hashcode of this instance.

Overrides:

hashCode in class java.lang.Object

Returns:

Long.hashCode(long) called on the id.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.