AggregateTranslator

@Deprecated public class org.apache.commons.lang3.text.translate.AggregateTranslator extends CharSequenceTranslator

Deprecated: As of 3.6, use Apache Commons Text AggregateTranslator.

Executes a sequence of translators one after the other. Execution ends whenever the first translator consumes code points from the input.

Since:

3.0

Constructors

AggregateTranslator(CharSequenceTranslator[])

Specify the translators to be used at creation time.

public AggregateTranslator(CharSequenceTranslator... translators)

Specify the translators to be used at creation time.

Parameters:

translators – CharSequenceTranslator array to aggregate

Methods

translate(CharSequence, int, Writer)

The first translator to consume code points from the input is the ‘winner’.

@Override public int translate(CharSequence input, int index, Writer out) throws IOException

The first translator to consume code points from the input is the ‘winner’. Execution stops with the number of consumed code points being returned. Translate a set of code points, represented by an int index into a CharSequence, into another set of code points. The number of code points consumed must be returned, and the only IOExceptions thrown must be from interacting with the Writer so that the top level API may reliably ignore StringWriter IOExceptions.

Parameters:

• input – CharSequence that is being translated.

• index – int representing the current point of translation.

• out – Writer to translate the text to.

Returns:

int count of code points consumed.

Throws:

java.io.IOException – Thrown if and only if the Writer produces an IOException.