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
|
/*
* 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.commons.lang3.text.translate;
import java.io.IOException;
import java.io.Writer;
/**
* Translates code points to their XML numeric entity escaped value.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityEscaper.html">
* NumericEntityEscaper</a> instead
*/
@Deprecated
public class NumericEntityEscaper extends CodePointTranslator {
private final int below;
private final int above;
private final boolean between;
/**
* Constructs a {@link NumericEntityEscaper} for the specified range. This is
* the underlying method for the other constructors/builders. The {@code below}
* and {@code above} boundaries are inclusive when {@code between} is
* {@code true} and exclusive when it is {@code false}.
*
* @param below int value representing the lowest code point boundary
* @param above int value representing the highest code point boundary
* @param between whether to escape between the boundaries or outside them
*/
private NumericEntityEscaper(final int below, final int above, final boolean between) {
this.below = below;
this.above = above;
this.between = between;
}
/**
* Constructs a {@link NumericEntityEscaper} for all characters.
*/
public NumericEntityEscaper() {
this(0, Integer.MAX_VALUE, true);
}
/**
* Constructs a {@link NumericEntityEscaper} below the specified value (exclusive).
*
* @param codePoint below which to escape
* @return the newly created {@link NumericEntityEscaper} instance
*/
public static NumericEntityEscaper below(final int codePoint) {
return outsideOf(codePoint, Integer.MAX_VALUE);
}
/**
* Constructs a {@link NumericEntityEscaper} above the specified value (exclusive).
*
* @param codePoint above which to escape
* @return the newly created {@link NumericEntityEscaper} instance
*/
public static NumericEntityEscaper above(final int codePoint) {
return outsideOf(0, codePoint);
}
/**
* Constructs a {@link NumericEntityEscaper} between the specified values (inclusive).
*
* @param codePointLow above which to escape
* @param codePointHigh below which to escape
* @return the newly created {@link NumericEntityEscaper} instance
*/
public static NumericEntityEscaper between(final int codePointLow, final int codePointHigh) {
return new NumericEntityEscaper(codePointLow, codePointHigh, true);
}
/**
* Constructs a {@link NumericEntityEscaper} outside of the specified values (exclusive).
*
* @param codePointLow below which to escape
* @param codePointHigh above which to escape
* @return the newly created {@link NumericEntityEscaper} instance
*/
public static NumericEntityEscaper outsideOf(final int codePointLow, final int codePointHigh) {
return new NumericEntityEscaper(codePointLow, codePointHigh, false);
}
/**
* {@inheritDoc}
*/
@Override
public boolean translate(final int codePoint, final Writer out) throws IOException {
if (between) {
if (codePoint < below || codePoint > above) {
return false;
}
} else if (codePoint >= below && codePoint <= above) {
return false;
}
out.write("&#");
out.write(Integer.toString(codePoint, 10));
out.write(';');
return true;
}
}
|
