 Known Direct Subclasses
| ByteToCharUTF16 |
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters, assuming an initial byte-order mark. |
| ByteToCharUnicodeBig |
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters, assuming a big-endian byte order. |
| ByteToCharUnicodeBigUnmarked |
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters, assuming a big-endian byte order and requiring no
byte-order mark. |
| ByteToCharUnicodeLittle |
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters, assuming a little-endian byte order. |
| ByteToCharUnicodeLittleUnmarked |
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters, assuming a little-endian byte order and requiring no
byte-order mark. |
|
Class Overview
Convert byte arrays containing Unicode characters into arrays of actual
Unicode characters. This class may be used directly, in which case it
expects the input byte array to begin with a byte-order mark, or it may be
subclassed in order to preset the byte order and mark behavior.
Whether or not a mark is expected, if a mark that does not match the
established byte order is later discovered then a
MalformedInputException will be thrown by the convert
method. If a correct mark is seen later in the input stream, it is passed
through as a character.
Summary
| Public Constructors |
|---|
|
|
ByteToCharUnicode()
Creates a Unicode byte-to-char converter that expects the first pair of
input bytes to be a byte-order mark, which will be interpreted and
discarded.
|
| Protected Constructors |
|---|
|
|
ByteToCharUnicode(int bo, boolean m)
Creates a Unicode byte-to-char converter that uses the given byte order
and may or may not insist upon an initial byte-order mark.
|
| Public Methods |
|---|
|
int
|
convert(byte[] in, int inOff, int inEnd, char[] out, int outOff, int outEnd)
Converts an array of bytes containing characters in an external
encoding into an array of Unicode characters.
|
|
int
|
flush(char[] buf, int off, int len)
Writes any remaining output to the output buffer and resets the
converter to its initial state.
|
|
String
|
getCharacterEncoding()
Returns the character set id for the conversion
|
|
void
|
reset()
Resets converter to its initial state.
|
|
[Expand]
Inherited Methods |
|---|
From class
sun.io.ByteToCharConverter
|
abstract
int
|
convert(byte[] input, int inStart, int inEnd, char[] output, int outStart, int outEnd)
Converts an array of bytes containing characters in an external
encoding into an array of Unicode characters.
|
|
char[]
|
convertAll(byte[] input)
Converts an array of bytes containing characters in an external
encoding into an array of Unicode characters.
|
|
abstract
int
|
flush(char[] output, int outStart, int outEnd)
Writes any remaining output to the output buffer and resets the
converter to its initial state.
|
|
int
|
getBadInputLength()
Returns the length, in bytes, of the input which caused a
MalformedInputException.
|
|
abstract
String
|
getCharacterEncoding()
Returns the character set id for the conversion
|
|
static
ByteToCharConverter
|
getConverter(String encoding)
Returns appropriate ByteToCharConverter subclass instance.
|
|
static
ByteToCharConverter
|
getDefault()
Create an instance of the default ByteToCharConverter subclass.
|
|
int
|
getMaxCharsPerByte()
Returns the maximum number of characters needed to convert a byte.
|
|
int
|
nextByteIndex()
Returns the index of the byte just past the last byte successfully
converted by the previous call to convert.
|
|
int
|
nextCharIndex()
Returns the index of the character just past the last character
written by the previous call to convert.
|
|
abstract
void
|
reset()
Resets converter to its initial state.
|
|
void
|
setSubstitutionChars(char[] c)
sets the substitution character to use
|
|
void
|
setSubstitutionMode(boolean doSub)
Sets converter into substitution mode.
|
|
String
|
toString()
returns a string representation of the character conversion
|
|
From class
java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this object.
|
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
|
int
|
hashCode()
Returns a hash code value for the object.
|
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
|
String
|
toString()
Returns a string representation of the object.
|
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object. |
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed. |
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed. |
|
Public Constructors
public
ByteToCharUnicode
()
Creates a Unicode byte-to-char converter that expects the first pair of
input bytes to be a byte-order mark, which will be interpreted and
discarded. If the first pair of bytes is not such a mark then a
MalformedInputException will be thrown by the convert method.
Protected Constructors
protected
ByteToCharUnicode
(int bo, boolean m)
Creates a Unicode byte-to-char converter that uses the given byte order
and may or may not insist upon an initial byte-order mark.
Public Methods
public
int
convert
(byte[] in, int inOff, int inEnd, char[] out, int outOff, int outEnd)
Converts an array of bytes containing characters in an external
encoding into an array of Unicode characters. This method allows
a buffer by buffer conversion of a data stream. The state of the
conversion is saved between calls to convert. Among other things,
this means multibyte input sequences can be split between calls.
If a call to convert results in an exception, the conversion may be
continued by calling convert again with suitably modified parameters.
All conversions should be finished with a call to the flush method.
Parameters
| in
| byte array containing text to be converted. |
| inOff
| begin conversion at this offset in input array. |
| inEnd
| stop conversion at this offset in input array (exclusive). |
| out
| character array to receive conversion result. |
| outOff
| start writing to output array at this offset. |
| outEnd
| stop writing to output array at this offset (exclusive). |
Returns
- the number of bytes written to output.
public
int
flush
(char[] buf, int off, int len)
Writes any remaining output to the output buffer and resets the
converter to its initial state.
Parameters
| buf
| char array to receive flushed output. |
| off
| start writing to output array at this offset. |
| len
| stop writing to output array at this offset (exclusive). |
public
String
getCharacterEncoding
()
Returns the character set id for the conversion
public
void
reset
()
Resets converter to its initial state.