org.apache.commons.text.translate.NumericEntityEscaper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-text Show documentation
Show all versions of commons-text Show documentation
Apache Commons Text is a library focused on algorithms working on strings.
The newest version!
/*
* 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.text.translate;
import java.io.IOException;
import java.io.Writer;
import org.apache.commons.lang3.Range;
/**
* Translates code points to their XML numeric entity escaped value.
*
* @since 1.0
*/
public class NumericEntityEscaper extends CodePointTranslator {
/**
* Constructs a {@code NumericEntityEscaper} above the specified value (exclusive).
*
* @param codePoint above which to escape
* @return The newly created {@code NumericEntityEscaper} instance
*/
public static NumericEntityEscaper above(final int codePoint) {
return outsideOf(0, codePoint);
}
/**
* Constructs a {@code NumericEntityEscaper} below the specified value (exclusive).
*
* @param codePoint below which to escape
* @return The newly created {@code NumericEntityEscaper} instance
*/
public static NumericEntityEscaper below(final int codePoint) {
return outsideOf(codePoint, Integer.MAX_VALUE);
}
/**
* Constructs a {@code NumericEntityEscaper} between the specified values (inclusive).
*
* @param codePointLow above which to escape
* @param codePointHigh below which to escape
* @return The newly created {@code NumericEntityEscaper} instance
*/
public static NumericEntityEscaper between(final int codePointLow, final int codePointHigh) {
return new NumericEntityEscaper(codePointLow, codePointHigh, true);
}
/**
* Constructs a {@code NumericEntityEscaper} outside of the specified values (exclusive).
*
* @param codePointLow below which to escape
* @param codePointHigh above which to escape
* @return The newly created {@code NumericEntityEscaper} instance
*/
public static NumericEntityEscaper outsideOf(final int codePointLow, final int codePointHigh) {
return new NumericEntityEscaper(codePointLow, codePointHigh, false);
}
/** Whether to escape between the boundaries or outside them. */
private final boolean between;
/** Range from lowest code point to highest code point. */
private final Range range;
/**
* Constructs a {@code NumericEntityEscaper} for all characters.
*/
public NumericEntityEscaper() {
this(0, Integer.MAX_VALUE, true);
}
/**
* Constructs a {@code 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.range = Range.of(below, above);
this.between = between;
}
/**
* {@inheritDoc}
*/
@Override
public boolean translate(final int codePoint, final Writer writer) throws IOException {
if (this.between != this.range.contains(codePoint)) {
return false;
}
writer.write("");
writer.write(Integer.toString(codePoint, 10));
writer.write(';');
return true;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy