/*
 * 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 codepoints to their XML numeric entity escaped value.
Since:3.0
Deprecated:as of 3.6, use commons-text NumericEntityEscaper instead
/** * Translates codepoints to their XML numeric entity escaped value. * * @since 3.0 * @deprecated as of 3.6, use 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 NumericEntityEscaper for the specified range. This is the underlying method for the other constructors/builders. The below and above boundaries are inclusive when between is true and exclusive when it is false.

Params:
  • below – int value representing the lowest codepoint boundary
  • above – int value representing the highest codepoint boundary
  • between – whether to escape between the boundaries or outside them
/** * <p>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}. </p> * * @param below int value representing the lowest codepoint boundary * @param above int value representing the highest codepoint 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 NumericEntityEscaper for all characters.

/** * <p>Constructs a {@code NumericEntityEscaper} for all characters. </p> */
public NumericEntityEscaper() { this(0, Integer.MAX_VALUE, true); }

Constructs a NumericEntityEscaper below the specified value (exclusive).

Params:
  • codepoint – below which to escape
Returns:the newly created NumericEntityEscaper instance
/** * <p>Constructs a {@code NumericEntityEscaper} below the specified value (exclusive). </p> * * @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 NumericEntityEscaper above the specified value (exclusive).

Params:
  • codepoint – above which to escape
Returns:the newly created NumericEntityEscaper instance
/** * <p>Constructs a {@code NumericEntityEscaper} above the specified value (exclusive). </p> * * @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 NumericEntityEscaper between the specified values (inclusive).

Params:
  • codepointLow – above which to escape
  • codepointHigh – below which to escape
Returns:the newly created NumericEntityEscaper instance
/** * <p>Constructs a {@code NumericEntityEscaper} between the specified values (inclusive). </p> * * @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 NumericEntityEscaper outside of the specified values (exclusive).

Params:
  • codepointLow – below which to escape
  • codepointHigh – above which to escape
Returns:the newly created NumericEntityEscaper instance
/** * <p>Constructs a {@code NumericEntityEscaper} outside of the specified values (exclusive). </p> * * @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); }
{@inheritDoc}
/** * {@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; } }