Charset

Charset

Charset (String canonicalName, 
                String[] aliases)

Initializes a new charset with the given canonical name and alias set.

aliases

Set<String> aliases ()

Returns a set containing this charset's aliases.

availableCharsets

SortedMap<String, Charset> availableCharsets ()

Constructs a sorted map from canonical charset names to charset objects.

The map returned by this method will have one entry for each charset for which support is available in the current Java virtual machine. If two or more supported charsets have the same canonical name then the resulting map will contain just one of them; which one it will contain is not specified.

The invocation of this method, and the subsequent use of the resulting map, may cause time-consuming disk or network I/O operations to occur. This method is provided for applications that need to enumerate all of the available charsets, for example to allow user charset selection. This method is not used by the forName method, which instead employs an efficient incremental lookup algorithm.

This method may return different results at different times if new charset providers are dynamically made available to the current Java virtual machine. In the absence of such changes, the charsets returned by this method are exactly those that can be retrieved via the forName method.

canEncode

boolean canEncode ()

Tells whether or not this charset supports encoding.

Nearly all charsets support encoding. The primary exceptions are special-purpose auto-detect charsets whose decoders can determine which of several possible encoding schemes is in use by examining the input byte sequence. Such charsets do not support encoding because there is no way to determine which encoding should be used on output. Implementations of such charsets should override this method to return false.

compareTo

int compareTo (Charset that)

Compares this charset to another.

Charsets are ordered by their canonical names, without regard to case.

contains

boolean contains (Charset cs)

Tells whether or not this charset contains the given charset.

A charset C is said to contain a charset D if, and only if, every character representable in D is also representable in C. If this relationship holds then it is guaranteed that every string that can be encoded in D can also be encoded in C without performing any replacements.

That C contains D does not imply that each character representable in C by a particular byte sequence is represented in D by the same byte sequence, although sometimes this is the case.

Every charset contains itself.

This method computes an approximation of the containment relation: If it returns true then the given charset is known to be contained by this charset; if it returns false, however, then it is not necessarily the case that the given charset is not contained in this charset.

decode

CharBuffer decode (ByteBuffer bb)

Convenience method that decodes bytes in this charset into Unicode characters.

An invocation of this method upon a charset cs returns the same result as the expression

     cs.newDecoder()
       .onMalformedInput(CodingErrorAction.REPLACE)
       .onUnmappableCharacter(CodingErrorAction.REPLACE)
       .decode(bb); 

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement byte array. In order to detect such sequences, use the decode(java.nio.ByteBuffer) method directly.

defaultCharset

Charset defaultCharset ()

Returns the default charset of this Java virtual machine.

The default charset is determined during virtual-machine startup and typically depends upon the locale and charset of the underlying operating system.

displayName

String displayName ()

Returns this charset's human-readable name for the default locale.

The default implementation of this method simply returns this charset's canonical name. Concrete subclasses of this class may override this method in order to provide a localized display name.

displayName

String displayName (Locale locale)

Returns this charset's human-readable name for the given locale.

The default implementation of this method simply returns this charset's canonical name. Concrete subclasses of this class may override this method in order to provide a localized display name.

encode

ByteBuffer encode (String str)

Convenience method that encodes a string into bytes in this charset.

An invocation of this method upon a charset cs returns the same result as the expression

     cs.encode(CharBuffer.wrap(s)); 

encode

ByteBuffer encode (CharBuffer cb)

Convenience method that encodes Unicode characters into bytes in this charset.

An invocation of this method upon a charset cs returns the same result as the expression

     cs.newEncoder()
       .onMalformedInput(CodingErrorAction.REPLACE)
       .onUnmappableCharacter(CodingErrorAction.REPLACE)
       .encode(bb); 

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. In order to detect such sequences, use the encode(java.nio.CharBuffer) method directly.

equals

boolean equals (Object ob)

Tells whether or not this object is equal to another.

Two charsets are equal if, and only if, they have the same canonical names. A charset is never equal to any other type of object.

forName

Charset forName (String charsetName)

Returns a charset object for the named charset.

hashCode

int hashCode ()

Computes a hashcode for this charset.

isRegistered

boolean isRegistered ()

Tells whether or not this charset is registered in the IANA Charset Registry.

isSupported

boolean isSupported (String charsetName)

Tells whether the named charset is supported.

name

String name ()

Returns this charset's canonical name.

newDecoder

CharsetDecoder newDecoder ()

Constructs a new decoder for this charset.

newEncoder

CharsetEncoder newEncoder ()

Constructs a new encoder for this charset.

toString

String toString ()

Returns a string describing this charset.