org.atmosphere.util
Class StringFilterAggregator

java.lang.Object
  org.atmosphere.util.StringFilterAggregator

All Implemented Interfaces:

BroadcastFilter

public class StringFilterAggregator
extends 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

Constructor Summary

StringFilterAggregator()

StringFilterAggregator(int maxBufferedString)

Method Summary

BroadcastFilter.BroadcastAction

filter(Object originalMessage, 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(Object originalMessage,
                                              Object message)

Description copied from interface: BroadcastFilter

Transform or Filter a message. Return null to tell the associated Broadcaster to discard the message, e.g to not broadcast it.

Specified by:

filter in interface BroadcastFilter

Parameters:

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

message - Object a message

Returns:

a transformed message.