rocks.xmpp.extensions.rtt.model

Class RealTimeText

java.lang.Object

rocks.xmpp.extensions.rtt.model.RealTimeText

public final class RealTimeText
extends Object

The implementation of the <rtt/> element in the urn:xmpp:rtt:0 namespace.

See Also:

XEP-0301: In-Band Real Time Text, XML Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealTimeText.Action An abstract base class for all three RTT actions.
static class	RealTimeText.EraseText The implementation of the <e/> element.
static class	RealTimeText.Event The real-time text event.
static class	RealTimeText.InsertText The implementation of the <t/> element.
static class	RealTimeText.WaitInterval The implementation of the <w/> element.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE urn:xmpp:rtt:0

Constructor Summary

Constructors

Constructor and Description
RealTimeText(RealTimeText.Event event, Collection<RealTimeText.Action> actions, int sequence, String id) Creates a <rtt/> element.

Method Summary

Modifier and Type	Method and Description
List<RealTimeText.Action>	getActions() Gets the actions.
RealTimeText.Event	getEvent() Gets the event.
String	getId() Gets the id.
Integer	getSequence() Gets the sequence.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

urn:xmpp:rtt:0

See Also:

Constant Field Values

Constructor Detail

RealTimeText

public RealTimeText(RealTimeText.Event event,
                    Collection<RealTimeText.Action> actions,
                    int sequence,
                    String id)

Creates a <rtt/> element.

Parameters:

event - The event.

actions - The actions.

sequence - The sequence number.

id - The id (optional).

Method Detail

getEvent

public final RealTimeText.Event getEvent()

Gets the event.

This attribute signals events for real-time text. If the 'event' attribute is omitted, event="edit" is assumed as the default.

Returns:

The event.

See Also:

4.2.2 event

getSequence

public final Integer getSequence()

Gets the sequence.

Returns:

The sequence.

See Also:

4.2.1 seq

getActions

public final List<RealTimeText.Action> getActions()

Gets the actions.

Returns:

The actions.

See Also:

4.6 Real-Time Text Actions

getId

public final String getId()

Gets the id.

Returns:

The id.

See Also:

4.2.3 id