org.kitteh.irc.client.library.util

Class BatchReferenceTag

java.lang.Object

org.kitteh.irc.client.library.util.BatchReferenceTag

public class BatchReferenceTag
extends Object

Represents a BATCH capability reference tag.

Constructor Summary

Constructors

Constructor and Description
BatchReferenceTag(@NonNull String referenceTag, @NonNull String type) Constructs a reference tag without parameters.
BatchReferenceTag(@NonNull String referenceTag, @NonNull String type, @NonNull List<String> parameters) Constructs a reference tag.

Method Summary

Modifier and Type	Method and Description
void	addEvent(@NonNull ClientReceiveServerMessageEvent event) Adds an event to the tag.
@NonNull List<ClientReceiveServerMessageEvent>	getEvents() Gets the events, in order, assigned to this tag.
@NonNull List<String>	getParameters() Gets the tag's parameters.
@NonNull String	getReferenceTag() Gets the reference tag.
@NonNull String	getType() Gets the tag's type

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchReferenceTag

public BatchReferenceTag(@NonNull String referenceTag,
                         @NonNull String type,
                         @NonNull List<String> parameters)

Constructs a reference tag.

Parameters:

referenceTag - the tag

type - the tag's type

parameters - any additional parameters

BatchReferenceTag

public BatchReferenceTag(@NonNull String referenceTag,
                         @NonNull String type)

Constructs a reference tag without parameters.

Parameters:

referenceTag - the tag

type - the tag's type

Method Detail

getReferenceTag

public @NonNull String getReferenceTag()

Gets the reference tag.

Returns:

the tag name

getType

public @NonNull String getType()

Gets the tag's type

Returns:

type

getParameters

public @NonNull List<String> getParameters()

Gets the tag's parameters.

Returns:

parameters or an empty list if there aren't any

getEvents

public @NonNull List<ClientReceiveServerMessageEvent> getEvents()

Gets the events, in order, assigned to this tag.

Returns:

events

addEvent

public void addEvent(@NonNull ClientReceiveServerMessageEvent event)

Adds an event to the tag.

Parameters:

event - event to add