Package com.tangosol.net.topic

Class Subscriber.CommitResult

java.lang.Object

com.tangosol.io.AbstractEvolvable

com.tangosol.net.topic.Subscriber.CommitResult

All Implemented Interfaces:

Evolvable, ExternalizableLite, PortableObject, Serializable

Enclosing interface:

Subscriber<V>

public static class Subscriber.CommitResult
extends AbstractEvolvable
implements PortableObject, ExternalizableLite

The result of a commit request.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DATA_VERSION	The evolvable version of this class.
static Subscriber.CommitResult	NOTHING_TO_COMMIT	A result indicating there was nothing to be committed.

Constructor Summary

Constructors

Constructor	Description
CommitResult()	Default constructor for serialization.
CommitResult(int nChannel, Position position, Subscriber.CommitResultStatus status)	Create a Subscriber.CommitResult.
CommitResult(int nChannel, Position position, Subscriber.CommitResultStatus status, Throwable throwable)	Create a rejected Subscriber.CommitResult.
CommitResult(int nChannel, Position position, Throwable throwable)	Create a rejected Subscriber.CommitResult.

Method Summary

Modifier and Type	Method	Description
OptionalInt	getChannel()	Returns the channel that the Position was committed in.
Optional<Throwable>	getError()	Returns an optional error that caused a commit to fail.
int	getImplVersion()	Determine the serialization version supported by the implementing class.
Optional<Position>	getPosition()	Returns the requested commit Position.
Subscriber.CommitResultStatus	getStatus()	Returns the result of the commit request.
boolean	isSuccess()	Returns true if the result can be considered successful, i.e. its status is not a failure status.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
String	toString()
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class com.tangosol.io.AbstractEvolvable

getDataVersion, getFutureData, setDataVersion, setFutureData

Methods inherited from class java.lang.Object

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

Field Detail

DATA_VERSION

public static final int DATA_VERSION

The evolvable version of this class.

See Also:

Constant Field Values

NOTHING_TO_COMMIT

public static final Subscriber.CommitResult NOTHING_TO_COMMIT

A result indicating there was nothing to be committed.

Constructor Detail

CommitResult

public CommitResult()

Default constructor for serialization.

CommitResult

public CommitResult(int nChannel,
                    Position position,
                    Subscriber.CommitResultStatus status)

Create a Subscriber.CommitResult.

Parameters:

position - the committed Position

status - the result of the commit request

CommitResult

public CommitResult(int nChannel,
                    Position position,
                    Throwable throwable)

Create a rejected Subscriber.CommitResult.

Parameters:

position - the committed Position

throwable - the error that caused the commit to fail

CommitResult

public CommitResult(int nChannel,
                    Position position,
                    Subscriber.CommitResultStatus status,
                    Throwable throwable)

Create a rejected Subscriber.CommitResult.

Parameters:

position - the committed Position

status - the result of the commit request

throwable - an optional error

Method Detail

getChannel

public OptionalInt getChannel()

Returns the channel that the Position was committed in.

Returns:

the channel that the Position was committed in

getPosition

public Optional<Position> getPosition()

Returns the requested commit Position.

Returns:

the requested commit Position

getStatus

public Subscriber.CommitResultStatus getStatus()

Returns the result of the commit request.

Returns:

the result of the commit request

getError

public Optional<Throwable> getError()

Returns an optional error that caused a commit to fail.

Returns:

an optional error that caused a commit to fail

isSuccess

public boolean isSuccess()

Returns true if the result can be considered successful, i.e. its status is not a failure status.

Returns:

true if the result can be considered successful

readExternal

public void readExternal(DataInput in)
                  throws IOException

Description copied from interface: ExternalizableLite

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Description copied from interface: ExternalizableLite

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

getImplVersion

public int getImplVersion()

Description copied from class: AbstractEvolvable

Determine the serialization version supported by the implementing class.

Specified by:

getImplVersion in interface Evolvable

Specified by:

getImplVersion in class AbstractEvolvable

Returns:

the serialization version supported by this object

readExternal

public void readExternal(PofReader in)
                  throws IOException

Description copied from interface: PortableObject

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Description copied from interface: PortableObject

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

toString

public String toString()

Overrides:

toString in class Object