Class AggregateTranslator

  extended by org.apache.commons.lang3.text.translate.CharSequenceTranslator
      extended by org.apache.commons.lang3.text.translate.AggregateTranslator

public class AggregateTranslator
extends CharSequenceTranslator

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

$Id: 1088899 2011-04-05 05:31:27Z bayard $

Constructor Summary
AggregateTranslator(CharSequenceTranslator... translators)
          Specify the translators to be used at creation time.
Method Summary
 int translate(CharSequence input, int index, Writer out)
          The first translator to consume codepoints from the input is the 'winner'.
Methods inherited from class org.apache.commons.lang3.text.translate.CharSequenceTranslator
hex, translate, translate, with
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public AggregateTranslator(CharSequenceTranslator... translators)
Specify the translators to be used at creation time.

translators - CharSequenceTranslator array to aggregate
Method Detail


public int translate(CharSequence input,
                     int index,
                     Writer out)
              throws IOException
The first translator to consume codepoints from the input is the 'winner'. Execution stops with the number of consumed codepoints being returned. Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints. The number of codepoints consumed must be returned, and the only IOExceptions thrown must be from interacting with the Writer so that the top level API may reliable ignore StringWriter IOExceptions.

Specified by:
translate in class CharSequenceTranslator
input - CharSequence that is being translated
index - int representing the current point of translation
out - Writer to translate the text to
int count of codepoints consumed
IOException - if and only if the Writer produces an IOException

Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.