blob: c48530c1c555abf4e4feedcb791b777d1cc66c42 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.events;
import java.util.Collections;
import java.util.EventObject;
import java.util.Map;
import org.apache.fop.events.model.EventSeverity;
/**
* 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.
*/
public class Event extends EventObject {
private static final long serialVersionUID = -1310594422868258083L;
private String eventGroupID;
private String eventKey;
private EventSeverity severity;
private Map params;
/**
* Creates a new Event.
* @param source the object that creates the event
* @param eventID the unique identifier of the event
* @param severity the severity level
* @param params the event parameters (a map of name/value pairs)
*/
public Event(Object source, String eventID, EventSeverity severity, Map params) {
super(source);
int pos = eventID.lastIndexOf('.');
if (pos < 0 || pos == eventID.length() - 1) {
eventKey = eventID;
} else {
eventGroupID = eventID.substring(0, pos);
eventKey = eventID.substring(pos + 1);
}
setSeverity(severity);
this.params = params;
}
/**
* Returns the event identifier.
* @return the event identifier
*/
public String getEventID() {
if (eventGroupID == null) {
return eventKey;
} else {
return eventGroupID + '.' + eventKey;
}
}
/**
* Returns the event group identifier.
* @return the event group identifier (or null if there is no group identifier)
*/
public String getEventGroupID() {
return eventGroupID;
}
/**
* Returns the event key.
* @return the event key
*/
public String getEventKey() {
return eventKey;
}
/**
* Returns the severity level.
* @return the severity level
*/
public EventSeverity getSeverity() {
return this.severity;
}
/**
* Sets the event's severity level. This method can be used to increase or decrease the
* severity level in a listener.
* @param severity the new event severity
*/
public void setSeverity(EventSeverity severity) {
this.severity = severity;
}
/**
* Returns a parameter.
* @param key the key to the parameter
* @return the parameter value or null if no value with this key is found
*/
public Object getParam(String key) {
if (this.params != null) {
return this.params.get(key);
} else {
return null;
}
}
/**
* Returns an unmodifiable {@link java.util.Map} with all event parameters.
* @return the parameter map
*/
public Map getParams() {
return Collections.unmodifiableMap(this.params);
}
/**
* Creates and returns a fluent builder object for building up the parameter map.
* @return the parameter builder
*/
public static ParamsBuilder paramsBuilder() {
return new ParamsBuilder();
}
/**
* This class is a fluent builder class for building up the parameter map.
*/
public static class ParamsBuilder {
private Map params;
/**
* Adds a new parameter (a name/value pair).
* @param name the name of the parameter
* @param value the value of the parameter
* @return this instance
*/
public ParamsBuilder param(String name, Object value) {
if (this.params == null) {
this.params = new java.util.HashMap();
}
this.params.put(name, value);
return this;
}
/**
* Returns the accumulated parameter map.
* @return the accumulated parameter map
*/
public Map build() {
return this.params;
}
}
}
|
