org.glassfish.grizzly.websockets.frame
Class ParseResult

java.lang.Object
  org.glassfish.grizzly.websockets.frame.ParseResult

All Implemented Interfaces:

Cacheable

public class ParseResult
extends Object
implements Cacheable

Frame parse result.

Author:

Alexey Stashok

Method Summary

static ParseResult	create(boolean isComplete, Buffer remainderBuffer) Create a ParseResult object.
Buffer	getRemainder() Get the parsing remainder Buffer.
boolean	isComplete() Returns true, if parsing was completed, or false if more data is expected.
void	recycle() Recycle the object.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ParseResult create(boolean isComplete,
                                 Buffer remainderBuffer)

Create a ParseResult object.

Parameters:

isComplete - was parsing completed?

remainderBuffer - the remainder.

Returns:

ParseResult

getRemainder

public Buffer getRemainder()

Get the parsing remainder Buffer. May not be null only in case, when parsing was completed, but some data is still ready for parsing.

Returns:

the parsing remainder Buffer. May not be null only in case, when parsing was completed, but some data is still ready for parsing.

isComplete

public boolean isComplete()

Returns true, if parsing was completed, or false if more data is expected.

Returns:

true, if parsing was completed, or false if more data is expected.

recycle

public void recycle()

Recycle the object.

Specified by:

recycle in interface Cacheable