public Class ParseResult

Class Inheritance

extends Object
implements Cacheable

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

All Implemented Interfaces

org.glassfish.grizzly.Cacheable

Imports

org.glassfish.grizzly.Buffer, .Cacheable, .ThreadCache

DataFrame parse result.

Author: Alexey Stashok

Field Summary

Modifier and Type	Field and Description
private static final ThreadCache.CachedTypeIndex<ParseResult>	CACHE_IDX
private boolean	isComplete
private Buffer	remainder

Constructor Summary

Access	Constructor and Description
private	ParseResult()

Method Summary

Modifier and Type	Method and Description
public static ParseResult	Returns: `ParseResult` create(boolean was parsing completed? isComplete, Buffer the remainder. remainderBuffer) Create a ParseResult object.
public Buffer	Returns: the parsing remainder `Buffer`. May not be null only in case, when parsing was completed, but some data is still ready for parsing. getRemainder() Get the parsing remainder `Buffer`.
public boolean	Returns: `true`, if parsing was completed, or `false` if more data is expected. isComplete() Returns `true`, if parsing was completed, or `false` if more data is expected.
public void	recycle() Implements org.glassfish.grizzly.Cacheable.recycle. Recycle the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CACHE_IDX	back to summary
private static final ThreadCache.CachedTypeIndex<ParseResult> CACHE_IDX

isComplete	back to summary
private boolean isComplete

remainder	back to summary
private Buffer remainder

Constructor Detail

ParseResult	back to summary
private ParseResult()

Method Detail

create back to summary

create	back to summary
public static ParseResult create(boolean isComplete, Buffer remainderBuffer) Create a ParseResult object. Parameters isComplete:boolean was parsing completed? remainderBuffer:Buffer the remainder. Returns:ParseResult `ParseResult`

public static ParseResult create(boolean isComplete, Buffer remainderBuffer)

Create a ParseResult object.

Parameters

isComplete:boolean: was parsing completed?
remainderBuffer:Buffer: the remainder.

Returns:ParseResult

ParseResult

getRemainder back to summary

getRemainder	back to summary
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:Buffer the parsing remainder `Buffer`. May not be null only in case, when parsing was completed, but some data is still ready for parsing.

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:Buffer: the parsing remainder Buffer. May not be null only in case, when parsing was completed, but some data is still ready for parsing.

isComplete back to summary

isComplete	back to summary
public boolean isComplete() Returns `true`, if parsing was completed, or `false` if more data is expected. Returns:boolean `true`, if parsing was completed, or `false` if more data is expected.

public boolean isComplete()

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

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

recycle	back to summary
public void recycle() Implements org.glassfish.grizzly.Cacheable.recycle. Recycle the object. Annotations @Override

recycle

back to summary

public void recycle()

Implements org.glassfish.grizzly.Cacheable.recycle.

Recycle the object.

Annotations

@Override