pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.service.event
Class PlainTextOutputEvent

java.lang.Object
  extended by org.torweg.pulse.service.event.PlainTextOutputEvent
All Implemented Interfaces:
Event

public final class PlainTextOutputEvent
extends java.lang.Object
implements Event

Version:
$Revision: 1393 $
Author:
Thomas Weber

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.torweg.pulse.service.event.Event
Event.Disposition
 
Constructor Summary
PlainTextOutputEvent(java.lang.String msg, java.lang.String enc)
          builds a new PlainTextOutputEvent which sends the given message.
 
Method Summary
 CacheMode getCacheMode()
          returns the CacheMode.
 boolean isOutputEvent()
          returns true.
 boolean isSingularEvent()
          Indicates that the Event will only be added once to the EventManager and block all other Events.
 boolean isStopEvent()
          returns true.
 void run(ServiceRequest req)
          performs the text output.
 void setCacheMode(CacheMode c)
          sets the CacheMode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlainTextOutputEvent

public PlainTextOutputEvent(java.lang.String msg,
                            java.lang.String enc)
builds a new PlainTextOutputEvent which sends the given message.

Parameters:
msg - the message to send
enc - the encoding to be used
Method Detail

isOutputEvent

public boolean isOutputEvent()
returns true.

Specified by:
isOutputEvent in interface Event
Returns:
true

isStopEvent

public boolean isStopEvent()
returns true.

Specified by:
isStopEvent in interface Event
Returns:
true
See Also:
Invoker

isSingularEvent

public boolean isSingularEvent()
Description copied from interface: Event
Indicates that the Event will only be added once to the EventManager and block all other Events.

If an Event of the same type has already been added to the EventManager, subsequent calls to EventManager.addEvent(Event) will return without adding the given Event.

Specified by:
isSingularEvent in interface Event
Returns:
true
See Also:
Event.isSingularEvent()

run

public void run(ServiceRequest req)
performs the text output.

Specified by:
run in interface Event
Parameters:
req - the request
See Also:
Event.run(org.torweg.pulse.service.request.ServiceRequest)

getCacheMode

public CacheMode getCacheMode()
returns the CacheMode.

Specified by:
getCacheMode in interface Event
Returns:
the cache mode
See Also:
Event.getCacheMode()

setCacheMode

public void setCacheMode(CacheMode c)
sets the CacheMode.

Specified by:
setCacheMode in interface Event
Parameters:
c - the cache mode to set
See Also:
Event.setCacheMode(org.torweg.pulse.service.request.CacheMode)