org.atmosphere.stomp.protocol

Class Parser

java.lang.Object

org.atmosphere.stomp.protocol.Parser

public class Parser
extends Object

This class parses text stream that respects STOMP protocol to extract a structured Frame that provides a set of information. A Frame contains:

• The Action
• The headers and their values
• The body in String value

If the text stream violates the STOMP protocol, then several ParseException could be thrown. The ParseException class provides different subclasses that detail the cause.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
Parser(String textStream) Builds a new Parser for the given text stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	parse() Parses the stream to extract data.
Frame	toFrame() Builds a Frame that provides information extracted from stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parser

public Parser(String textStream)

Builds a new Parser for the given text stream.

Parameters:

textStream - the String to parse

Method Detail

parse

public void parse()

Parses the stream to extract data.

toFrame

public Frame toFrame()
              throws ParseException

Builds a Frame that provides information extracted from stream. If parse() has not been already called, then this method invokes it.

If the result of the parse() operation has detected any protocol violation, then the appropriate ParseException is thrown by this method.

Returns:

the message

Throws:

ParseException - if stream violates STOMP protocol