|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.apache.fop.events.Event
public class Event
This is the default event class used by this package. Each event has a unique event identifier (a String), a severity indicator and a map of name/value pairs.
Nested Class Summary | |
---|---|
static class |
Event.ParamsBuilder
This class is a fluent builder class for building up the parameter map. |
Field Summary |
---|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
Event(java.lang.Object source,
java.lang.String eventID,
EventSeverity severity,
java.util.Map params)
Creates a new Event. |
Method Summary | |
---|---|
java.lang.String |
getEventGroupID()
Returns the event group identifier. |
java.lang.String |
getEventID()
Returns the event identifier. |
java.lang.String |
getEventKey()
Returns the event key. |
java.lang.Object |
getParam(java.lang.String key)
Returns a parameter. |
java.util.Map |
getParams()
Returns an unmodifiable Map with all event parameters. |
EventSeverity |
getSeverity()
Returns the severity level. |
static Event.ParamsBuilder |
paramsBuilder()
Creates and returns a fluent builder object for building up the parameter map. |
void |
setSeverity(EventSeverity severity)
Sets the event's severity level. |
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Event(java.lang.Object source, java.lang.String eventID, EventSeverity severity, java.util.Map params)
source
- the object that creates the eventeventID
- the unique identifier of the eventseverity
- the severity levelparams
- the event parameters (a map of name/value pairs)Method Detail |
---|
public java.lang.String getEventID()
public java.lang.String getEventGroupID()
public java.lang.String getEventKey()
public EventSeverity getSeverity()
public void setSeverity(EventSeverity severity)
severity
- the new event severitypublic java.lang.Object getParam(java.lang.String key)
key
- the key to the parameter
public java.util.Map getParams()
Map
with all event parameters.
public static Event.ParamsBuilder paramsBuilder()
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |