Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.lang3.text.translate
Class LookupTranslator

    java.lang.Object
      org.apache.commons.lang3.text.translate.CharSequenceTranslator
          org.apache.commons.lang3.text.translate.LookupTranslator

    public class LookupTranslator

extends CharSequenceTranslator

Translates a value using a lookup table.

Since:
  3.0
Version:
  $Id: LookupTranslator.java 1091096 2011-04-11 15:07:29Z mbenson $

Constructor Summary
`LookupTranslator(CharSequence[]... lookup)` Define the lookup table to be used in translation

Method Summary
`int` | `translate(CharSequence input, int index, Writer out)` Translate a set of codepoints, represented by an int index into a CharSequence, into another set of codepoints.

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

### LookupTranslator

    public LookupTranslator(CharSequence[]... lookup)

  Define the lookup table to be used in translation

  Parameters:
    `lookup` - CharSequence[][] table of size [*][2]

Method Detail

### translate

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

  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`
  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 codepoints consumed
  Throws:
    `IOException` - if and only if the Writer produces an IOException

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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