org.atmosphere.jersey

Class SuspendResponse.SuspendResponseBuilder<E>

java.lang.Object

com.sun.jersey.api.JResponse.AJResponseBuilder<E,SuspendResponse.SuspendResponseBuilder<E>>

org.atmosphere.jersey.SuspendResponse.SuspendResponseBuilder<E>

Type Parameters:

E -

Enclosing class:

SuspendResponse<E>

public static class SuspendResponse.SuspendResponseBuilder<E>
extends com.sun.jersey.api.JResponse.AJResponseBuilder<E,SuspendResponse.SuspendResponseBuilder<E>>

A Builder for SuspendResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<AtmosphereResourceEventListener>	listeners
protected boolean	outputComments
protected boolean	resumeOnBroadcast
protected Suspend.SCOPE	scope
protected SuspendResponse.TimeSpan	suspendTimeout

Fields inherited from class com.sun.jersey.api.JResponse.AJResponseBuilder

entity, headers, statusType

Constructor Summary

Constructors

Constructor and Description
SuspendResponse.SuspendResponseBuilder() Default constructor.
SuspendResponse.SuspendResponseBuilder(SuspendResponse.SuspendResponseBuilder<E> that) Construct a shallow copy.

Method Summary

Methods

Modifier and Type	Method and Description
SuspendResponse.SuspendResponseBuilder<E>	addListener(AtmosphereResourceEventListener e) Add AtmosphereResourceEventListener
SuspendResponse.SuspendResponseBuilder<E>	broadcaster(Broadcaster broadcaster) Set the Broadcaster
SuspendResponse<E>	build() Build the SuspendResponse
SuspendResponse.SuspendResponseBuilder<E>	outputComments(boolean outputComments) Set true to tell Atmosphere to write comments when suspending.
SuspendResponse.SuspendResponseBuilder<E>	period(int suspendTimeout, TimeUnit timeUnit) Set the timeout period.
SuspendResponse.SuspendResponseBuilder<E>	resumeOnBroadcast(boolean resumeOnBroadcast) Set to true to resume the connection on the first Broadcaster.broadcast(Object)
SuspendResponse.SuspendResponseBuilder<E>	scope(Suspend.SCOPE scope) Set the Suspend.SCOPE value
SuspendResponse.SuspendResponseBuilder<E>	writeEntity(boolean writeEntity) Write the returned entity back to the calling connection.

Methods inherited from class com.sun.jersey.api.JResponse.AJResponseBuilder

cacheControl, contentLocation, cookie, encoding, entity, expires, getEntity, getMetadata, getStatus, getStatusType, header, header, headerSingle, language, language, lastModified, location, reset, status, status, status, tag, tag, type, type, variant, variants

Methods inherited from class java.lang.Object

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

Field Detail

suspendTimeout

protected SuspendResponse.TimeSpan suspendTimeout

scope

protected Suspend.SCOPE scope

outputComments

protected boolean outputComments

resumeOnBroadcast

protected boolean resumeOnBroadcast

listeners

protected final Collection<AtmosphereResourceEventListener> listeners

Constructor Detail

SuspendResponse.SuspendResponseBuilder

public SuspendResponse.SuspendResponseBuilder()

Default constructor.

SuspendResponse.SuspendResponseBuilder

public SuspendResponse.SuspendResponseBuilder(SuspendResponse.SuspendResponseBuilder<E> that)

Construct a shallow copy. The metadata map will be copied but not the key/value references.

Parameters:

that - the AJResponseBuilder to copy from.

Method Detail

scope

public SuspendResponse.SuspendResponseBuilder<E> scope(Suspend.SCOPE scope)

Set the Suspend.SCOPE value

Parameters:

scope - Suspend.SCOPE value

Returns:

this

period

public SuspendResponse.SuspendResponseBuilder<E> period(int suspendTimeout,
                                               TimeUnit timeUnit)

Set the timeout period.

Parameters:

suspendTimeout - the period

timeUnit - the TimeUnit

Returns:

this

outputComments

public SuspendResponse.SuspendResponseBuilder<E> outputComments(boolean outputComments)

Set true to tell Atmosphere to write comments when suspending.

Parameters:

outputComments - true to tell Atmosphere to write comments when suspending

Returns:

this

resumeOnBroadcast

public SuspendResponse.SuspendResponseBuilder<E> resumeOnBroadcast(boolean resumeOnBroadcast)

Set to true to resume the connection on the first Broadcaster.broadcast(Object)

Parameters:

resumeOnBroadcast - true to resume the connection on the first Broadcaster.broadcast(Object)

Returns:

this

broadcaster

public SuspendResponse.SuspendResponseBuilder<E> broadcaster(Broadcaster broadcaster)

Set the Broadcaster

Parameters:

broadcaster - Broadcaster

Returns:

this

writeEntity

public SuspendResponse.SuspendResponseBuilder<E> writeEntity(boolean writeEntity)

Write the returned entity back to the calling connection. Default is false.

addListener

public SuspendResponse.SuspendResponseBuilder<E> addListener(AtmosphereResourceEventListener e)

Add AtmosphereResourceEventListener

Parameters:

e - AtmosphereResourceEventListener

Returns:

this

build

public SuspendResponse<E> build()

Build the SuspendResponse

Returns:

an instance of SuspendResponse