org.atmosphere.util

Class StringFilterAggregator

java.lang.Object

org.atmosphere.util.StringFilterAggregator

All Implemented Interfaces:

BroadcastFilter

public class StringFilterAggregator
extends java.lang.Object
implements BroadcastFilter

Simple Aggregator that aggregate broadcasted String until it reach the limit.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcastFilter

BroadcastFilter.BroadcastAction

Field Summary

Fields inherited from interface org.atmosphere.cpr.BroadcastFilter

VOID_ATMOSPHERE_RESOURCE_UUID

Constructor Summary

Constructors

Constructor and Description
StringFilterAggregator()
StringFilterAggregator(int maxBufferedString)

Method Summary

Modifier and Type	Method and Description
BroadcastFilter.BroadcastAction	filter(java.lang.String broadcasterId, java.lang.Object originalMessage, java.lang.Object message) Transform or filter a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFilterAggregator

public StringFilterAggregator()

StringFilterAggregator

public StringFilterAggregator(int maxBufferedString)

Method Detail

filter

public BroadcastFilter.BroadcastAction filter(java.lang.String broadcasterId,
                                              java.lang.Object originalMessage,
                                              java.lang.Object message)

Description copied from interface: BroadcastFilter

Transform or filter a message. Return BroadcastAction(ACTION.ABORT, message) Broadcaster to discard the message, eg. to not broadcast it.

Specified by:

filter in interface BroadcastFilter

Parameters:

broadcasterId - the Broadcaster.getID() calling this object

originalMessage - The original message which was Broadcaster.broadcast(Object);

message - The transformed or not message.

Returns:

a transformed message.