org.atmosphere.stomp.protocol

Class Frame

java.lang.Object

org.atmosphere.stomp.protocol.Frame

public final class Frame
extends Object

In STOMP protocol, the frame basically defines an Action, some headers and eventually a body.

A frame is immutable.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
Frame(Action action, Map<String,String> headers) Builds a new instance without body.
Frame(Action action, Map<String,String> headers, String body) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Action	getAction() Gets the action.
String	getBody() Gets the body.
Map<String,String>	getHeaders() Gets the headers.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame(Action action,
     Map<String,String> headers,
     String body)

Builds a new instance.

Parameters:

action - the action

headers - the headers

body - the body

Frame

public Frame(Action action,
     Map<String,String> headers)

Builds a new instance without body.

Parameters:

action - the action

headers - the headers

Method Detail

getAction

public Action getAction()

Gets the action.

Returns:

the action

getBody

public String getBody()

Gets the body.

Returns:

the body

getHeaders

public Map<String,String> getHeaders()

Gets the headers.

Returns:

the headers