org.kitteh.irc.client.library.event.batch

Class ClientBatchStartEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

org.kitteh.irc.client.library.event.abstractbase.ClientBatchEventBase

org.kitteh.irc.client.library.event.batch.ClientBatchStartEvent

All Implemented Interfaces:

ClientLinked, BatchEvent, ClientEvent, ServerMessageEvent

public class ClientBatchStartEvent
extends ClientBatchEventBase

A batch has started.

Constructor Summary

Constructors

Constructor and Description
ClientBatchStartEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull BatchReferenceTag batchReferenceTag) Constructs the event.

Method Summary

Modifier and Type	Method and Description
boolean	isReferenceTagIgnored() Gets if the reference tag will be ignored, resulting in tagged messages being processed as if the batch tag were not holding them back.
void	setReferenceTagIgnored(boolean ignore) Sets if the reference tag will be ignored, resulting in tagged messages being processed as if the batch tag were not holding them back.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientBatchEventBase

getReferenceTag

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase

getSource, toStringer

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getTag, getTag, getTags

Constructor Detail

ClientBatchStartEvent

public ClientBatchStartEvent(@NonNull Client client,
                             @NonNull ServerMessage sourceMessage,
                             @NonNull BatchReferenceTag batchReferenceTag)

Constructs the event.

Parameters:

client - the client

sourceMessage - source message

batchReferenceTag - reference-tag and associated information

Method Detail

isReferenceTagIgnored

public boolean isReferenceTagIgnored()

Gets if the reference tag will be ignored, resulting in tagged messages being processed as if the batch tag were not holding them back.

Returns:

true if the tag will be ignored

See Also:

setReferenceTagIgnored(boolean)

setReferenceTagIgnored

public void setReferenceTagIgnored(boolean ignore)

Sets if the reference tag will be ignored, resulting in tagged messages being processed as if the batch tag were not holding them back.

Parameters:

ignore - true to ignore the tag