summaryrefslogtreecommitdiffstats
path: root/dom/src/test/java/org/w3c/domts/DocumentBuilderSetting.java
blob: 7aaf652eff0190be1e44dea76aa3ac0d275643e3 (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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/*
 * Copyright (c) 2001-2004 World Wide Web Consortium, (Massachusetts Institute
 * of Technology, Institut National de Recherche en Informatique et en
 * Automatique, Keio University). All Rights Reserved. This program is
 * distributed under the W3C's Software Intellectual Property License. This
 * program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See W3C License
 * http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.domts;

import javax.xml.parsers.DocumentBuilderFactory;

/**
 * This class is an parser setting, such as non-validating or entity-expanding.
 *
 * @author Curt Arnold @date 2 Feb 2002
 */
public final class DocumentBuilderSetting {
  /**
   * property name.
   */
  private final String property;

  /**
   *   property value.
   */
  private final boolean value;

  /**
   * strategy used to set or get property value.
   */
  private final DocumentBuilderSettingStrategy strategy;

  /**
   * coalescing = true.
   */
  public static final DocumentBuilderSetting coalescing =
      new DocumentBuilderSetting(
      "coalescing",
      true,
      DocumentBuilderSettingStrategy.coalescing);

  /**
   * coalescing = false.
   */
  public static final DocumentBuilderSetting notCoalescing =
      new DocumentBuilderSetting(
      "coalescing",
      false,
      DocumentBuilderSettingStrategy.coalescing);

  /**
   * expandEntityReferences = false.
   */
  public static final DocumentBuilderSetting expandEntityReferences =
      new DocumentBuilderSetting(
      "expandEntityReferences",
      true,
      DocumentBuilderSettingStrategy.expandEntityReferences);

  /**
   * expandEntityReferences = true.
   */
  public static final DocumentBuilderSetting notExpandEntityReferences =
      new DocumentBuilderSetting(
      "expandEntityReferences",
      false,
      DocumentBuilderSettingStrategy.expandEntityReferences);

  /**
   * ignoringElementContentWhitespace = true.
   */
  public static final DocumentBuilderSetting ignoringElementContentWhitespace =
      new DocumentBuilderSetting(
      "ignoringElementContentWhitespace",
      true,
      DocumentBuilderSettingStrategy.ignoringElementContentWhitespace);

  /**
   * ignoringElementContentWhitespace = false.
   */
  public static final DocumentBuilderSetting
      notIgnoringElementContentWhitespace =
      new DocumentBuilderSetting(
      "ignoringElementContentWhitespace",
      false,
      DocumentBuilderSettingStrategy.ignoringElementContentWhitespace);

  /**
   * namespaceAware = true.
   */
  public static final DocumentBuilderSetting namespaceAware =
      new DocumentBuilderSetting(
      "namespaceAware",
      true,
      DocumentBuilderSettingStrategy.namespaceAware);

  /**
   * namespaceAware = false.
   */
  public static final DocumentBuilderSetting notNamespaceAware =
      new DocumentBuilderSetting(
      "namespaceAware",
      false,
      DocumentBuilderSettingStrategy.namespaceAware);

  /**
   * validating = true.
   */
  public static final DocumentBuilderSetting validating =
      new DocumentBuilderSetting(
      "validating",
      true,
      DocumentBuilderSettingStrategy.validating);

  /**
   * validating = false.
   */
  public static final DocumentBuilderSetting notValidating =
      new DocumentBuilderSetting(
      "validating",
      false,
      DocumentBuilderSettingStrategy.validating);

  /**
   * signed = true.
   */
  public static final DocumentBuilderSetting signed =
      new DocumentBuilderSetting(
      "signed",
      true,
      DocumentBuilderSettingStrategy.signed);

  /**
   * signed = false.
   */
  public static final DocumentBuilderSetting notSigned =
      new DocumentBuilderSetting(
      "signed",
      false,
      DocumentBuilderSettingStrategy.signed);

  /**
   * hasNullString = true.
   */
  public static final DocumentBuilderSetting hasNullString =
      new DocumentBuilderSetting(
      "hasNullString",
      true,
      DocumentBuilderSettingStrategy.hasNullString);

  /**
   * hasNullString = false.
   */
  public static final DocumentBuilderSetting notHasNullString =
      new DocumentBuilderSetting(
      "hasNullString",
      false,
      DocumentBuilderSettingStrategy.hasNullString);

  /**
   * Schema validating enabled.
   */
  public static final DocumentBuilderSetting schemaValidating =
      new DocumentBuilderSetting(
      "schemaValidating",
      true,
      DocumentBuilderSettingStrategy.schemaValidating);

  /**
   * Schema validating disabled.
   */
  public static final DocumentBuilderSetting notSchemaValidating =
      new DocumentBuilderSetting(
      "schemaValidating",
      false,
      DocumentBuilderSettingStrategy.schemaValidating);

  /**
   * Comments ignored.
   */
  public static final DocumentBuilderSetting ignoringComments =
      new DocumentBuilderSetting(
      "ignoringComments",
      true,
      DocumentBuilderSettingStrategy.ignoringComments);

  /**
   * Comments preserved.
   */
  public static final DocumentBuilderSetting notIgnoringComments =
      new DocumentBuilderSetting(
      "ignoringComments",
      false,
      DocumentBuilderSettingStrategy.ignoringComments);

  /**
   * Protected constructor, use static members for supported settings.
   * @param property property name, follows JAXP.
   * @param value property value
   * @param strategy strategy, may not be null
   */
  protected DocumentBuilderSetting(
      String property,
      boolean value,
      DocumentBuilderSettingStrategy strategy) {
    if (property == null) {
      throw new NullPointerException("property");
    }
    this.property = property;
    this.value = value;
    this.strategy = strategy;
  }

  /**
   * Returns true if the settings have a conflict or are identical.
   *
   * @param other
   *            other setting, may not be null.
   * @return true if this setting and the specified setting conflict
   */
  public final boolean hasConflict(DocumentBuilderSetting other) {
    if (other == null) {
      throw new NullPointerException("other");
    }
    if (other == this) {
      return true;
    }
    return strategy.hasConflict(other.strategy);
  }

  /**
   * Determines current value of setting.
   * @param factory DOMTestDocumentBuilderFactory factory
   * @return boolean true if property enabled.
   */
  public final boolean hasSetting(DOMTestDocumentBuilderFactory factory) {
    return strategy.hasSetting(factory) == value;
  }

  /**
   * Attempts to change builder to have this setting.
   * @param factory DocumentBuilderFactory Factory for DOM builders
   * @throws DOMTestIncompatibleException
   *      if factory does not support the setting
   */
  public final void applySetting(DocumentBuilderFactory factory) throws
      DOMTestIncompatibleException {
    strategy.applySetting(factory, value);
  }

  /**
   * Gets the property name.
   * @return property name
   */
  public final String getProperty() {
    return property;
  }

  /**
   * Gets the property value.
   * @return property value
   */
  public final boolean getValue() {
    return value;
  }

  /**
   * Gets a string representation of the setting.
   * @return string representation
   */
  public final String toString() {
    StringBuffer builder = new StringBuffer(property);
    builder.append('=');
    builder.append(String.valueOf(value));
    return builder.toString();
  }

}