org.snf4j.core.engine

Class EngineResult

java.lang.Object

org.snf4j.core.engine.EngineResult

All Implemented Interfaces:

IEngineResult

public class EngineResult
extends Object
implements IEngineResult

The default implementation of the IEngineResult interface.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
EngineResult(Status status, HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
int	bytesConsumed() Returns the number of bytes consumed from the input buffer.
int	bytesProduced() Returns the number of bytes written to the output buffer.
HandshakeStatus	getHandshakeStatus() Gets the current handshake status produced by the IEngine call.
Status	getStatus() Gets the overall result of the IEngine calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineResult

public EngineResult(Status status,
                    HandshakeStatus handshakeStatus,
                    int bytesConsumed,
                    int bytesProduced)

Initializes a new instance of this class.

Parameters:

status - the return value of the operation

handshakeStatus - the current handshaking status

bytesConsumed - the number of bytes consumed from the input buffer

bytesProduced - the number of bytes placed into the output buffer

Throws:

IllegalArgumentException - if the status or handshakeStatus arguments are null, or if bytesConsumed or bytesProduced is negative.

Method Detail

bytesConsumed

public final int bytesConsumed()

Description copied from interface: IEngineResult

Returns the number of bytes consumed from the input buffer.

Specified by:

bytesConsumed in interface IEngineResult

Returns:

the number of bytes consumed.

bytesProduced

public final int bytesProduced()

Description copied from interface: IEngineResult

Returns the number of bytes written to the output buffer.

Specified by:

bytesProduced in interface IEngineResult

Returns:

the number of bytes produced

getStatus

public final Status getStatus()

Description copied from interface: IEngineResult

Gets the overall result of the IEngine calls.

Specified by:

getStatus in interface IEngineResult

Returns:

the return value

getHandshakeStatus

public final HandshakeStatus getHandshakeStatus()

Description copied from interface: IEngineResult

Gets the current handshake status produced by the IEngine call. It should match the value returned by the IEngine.getHandshakeStatus() method. The only exception to this rule is when the call has just finished the ongoing handshake. In such situation this method should return the HandshakeStatus.FINISHED status which is forbidden for the IEngine.getHandshakeStatus() method.

Specified by:

getHandshakeStatus in interface IEngineResult

Returns:

the handshake status