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
167
|
/*
* 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.
*/
package org.apache.tomcat.util.digester;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* <p><code>Rules</code> <em>Decorator</em> that returns default rules
* when no matches are returned by the wrapped implementation.</p>
*
* <p>This allows default <code>Rule</code> instances to be added to any
* existing <code>Rules</code> implementation. These default <code>Rule</code>
* instances will be returned for any match for which the wrapped
* implementation does not return any matches.</p>
* <p> For example,
* <pre>
* Rule alpha;
* ...
* WithDefaultsRulesWrapper rules = new WithDefaultsRulesWrapper(new BaseRules());
* rules.addDefault(alpha);
* ...
* digester.setRules(rules);
* ...
* </pre>
* when a pattern does not match any other rule, then rule alpha will be called.
* </p>
* <p><code>WithDefaultsRulesWrapper</code> follows the <em>Decorator</em> pattern.</p>
*
* @since 1.6
*/
public class WithDefaultsRulesWrapper implements Rules {
// --------------------------------------------------------- Fields
/** The Rules implementation that this class wraps. */
private Rules wrappedRules;
/** Rules to be fired when the wrapped implementations returns none. */
private List<Rule> defaultRules = new ArrayList<Rule>();
/** All rules (preserves order in which they were originally added) */
private List<Rule> allRules = new ArrayList<Rule>();
// --------------------------------------------------------- Constructor
/**
* Base constructor.
*
* @param wrappedRules the wrapped <code>Rules</code> implementation, not null
* @throws IllegalArgumentException when <code>wrappedRules</code> is null
*/
public WithDefaultsRulesWrapper(Rules wrappedRules) {
if (wrappedRules == null) {
throw new IllegalArgumentException("Wrapped rules must not be null");
}
this.wrappedRules = wrappedRules;
}
// --------------------------------------------------------- Properties
/** Gets digester using these Rules */
@Override
public Digester getDigester() {
return wrappedRules.getDigester();
}
/** Sets digester using these Rules */
@Override
public void setDigester(Digester digester) {
wrappedRules.setDigester(digester);
Iterator<Rule> it = defaultRules.iterator();
while (it.hasNext()) {
Rule rule = it.next();
rule.setDigester(digester);
}
}
/** Gets namespace to apply to Rule's added */
@Override
public String getNamespaceURI() {
return wrappedRules.getNamespaceURI();
}
/** Sets namespace to apply to Rule's added subsequently */
@Override
public void setNamespaceURI(String namespaceURI) {
wrappedRules.setNamespaceURI(namespaceURI);
}
/** Gets Rule's which will be fired when the wrapped implementation returns no matches */
public List<Rule> getDefaults() {
return defaultRules;
}
// --------------------------------------------------------- Public Methods
/**
* Return list of rules matching given pattern.
* If wrapped implementation returns any matches return those.
* Otherwise, return default matches.
*/
@Override
public List<Rule> match(String namespaceURI, String pattern) {
List<Rule> matches = wrappedRules.match(namespaceURI, pattern);
if (matches == null || matches.isEmpty()) {
// a little bit of defensive programming
return new ArrayList<Rule>(defaultRules);
}
// otherwise
return matches;
}
/** Adds a rule to be fired when wrapped implementation returns no matches */
public void addDefault(Rule rule) {
// set up rule
if (wrappedRules.getDigester() != null) {
rule.setDigester(wrappedRules.getDigester());
}
if (wrappedRules.getNamespaceURI() != null) {
rule.setNamespaceURI(wrappedRules.getNamespaceURI());
}
defaultRules.add(rule);
allRules.add(rule);
}
/** Gets all rules */
@Override
public List<Rule> rules() {
return allRules;
}
/** Clears all Rule's */
@Override
public void clear() {
wrappedRules.clear();
allRules.clear();
defaultRules.clear();
}
/**
* Adds a Rule to be fired on given pattern.
* Pattern matching is delegated to wrapped implementation.
*/
@Override
public void add(String pattern, Rule rule) {
wrappedRules.add(pattern, rule);
allRules.add(rule);
}
}
|
