Apache Commons Compress 1.26.0 · org.apache.commons.compress.utils.Charsets

Charsets required of every implementation of the Java platform. From the Java documentation Standard charsets:

Every implementation of the Java platform is required to support the following character encodings. Consult the release documentation for your implementation to see if any other encodings are supported. Consult the release documentation for your implementation to see if any other encodings are supported.

US-ASCII: Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.
ISO-8859-1: ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
UTF-8: Eight-bit Unicode Transformation Format.
UTF-16BE: Sixteen-bit Unicode Transformation Format, big-endian byte order.
UTF-16LE: Sixteen-bit Unicode Transformation Format, little-endian byte order.
UTF-16: Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output.)

This class best belongs in the Commons Lang or IO project. Even if a similar class is defined in another Commons component, it is not foreseen that Commons Compress would be made to depend on another Commons component.

Field Summary

Modifier and Type	Field and Description
public static final Charset	ISO_8859_1 CharsetNamesISO Latin Alphabet No.
public static final Charset	US_ASCII Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
public static final Charset	UTF_16 Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output) Every implementation of the Java platform is required to support this character encoding.
public static final Charset	UTF_16BE Sixteen-bit Unicode Transformation Format, big-endian byte order.
public static final Charset	UTF_16LE Sixteen-bit Unicode Transformation Format, little-endian byte order.
public static final Charset	UTF_8 Eight-bit Unicode Transformation Format.

Constructor Summary

Access	Constructor and Description
public	Charsets()

Method Summary

Modifier and Type	Method and Description
public static Charset	Returns: the given Charset or the default Charset if the given Charset is null toCharset(final Charset A charset or null. charset) Returns the given Charset or the default Charset if the given Charset is null.
public static Charset	Returns: a Charset for the named charset toCharset(final String The name of the requested charset, may be null. charset) Returns a Charset for the named charset.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ISO_8859_1 back to summary

ISO_8859_1	back to summary
public static final Charset ISO_8859_1 Deprecated replaced by `StandardCharsets` in Java 7 CharsetNamesISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset ISO_8859_1

Deprecated

replaced by StandardCharsets in Java 7

CharsetNamesISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

US_ASCII back to summary

US_ASCII	back to summary
public static final Charset US_ASCII Deprecated replaced by `StandardCharsets` in Java 7 Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set. Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset US_ASCII

Deprecated

replaced by StandardCharsets in Java 7

Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

UTF_16 back to summary

UTF_16	back to summary
public static final Charset UTF_16 Deprecated replaced by `StandardCharsets` in Java 7 Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output) Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset UTF_16

Deprecated

replaced by StandardCharsets in Java 7

Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output)

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

UTF_16BE back to summary

UTF_16BE	back to summary
public static final Charset UTF_16BE Deprecated replaced by `StandardCharsets` in Java 7 Sixteen-bit Unicode Transformation Format, big-endian byte order. Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset UTF_16BE

Deprecated

replaced by StandardCharsets in Java 7

Sixteen-bit Unicode Transformation Format, big-endian byte order.

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

UTF_16LE back to summary

UTF_16LE	back to summary
public static final Charset UTF_16LE Deprecated replaced by `StandardCharsets` in Java 7 Sixteen-bit Unicode Transformation Format, little-endian byte order. Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset UTF_16LE

Deprecated

replaced by StandardCharsets in Java 7

Sixteen-bit Unicode Transformation Format, little-endian byte order.

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

UTF_8 back to summary

UTF_8	back to summary
public static final Charset UTF_8 Deprecated replaced by `StandardCharsets` in Java 7 Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding. Annotations @Deprecated See Also Standard charsets

public static final Charset UTF_8

Deprecated

replaced by StandardCharsets in Java 7

Eight-bit Unicode Transformation Format.

Every implementation of the Java platform is required to support this character encoding.

Annotations

@Deprecated

See Also: Standard charsets

Constructor Detail

Charsets	back to summary
public Charsets()

Method Detail

toCharset	back to summary
public static Charset toCharset(final Charset charset) Returns the given Charset or the default Charset if the given Charset is null. Parameters charset:Charset A charset or null. Returns:Charset the given Charset or the default Charset if the given Charset is null

toCharset

back to summary

public static Charset toCharset(final Charset charset)

Returns the given Charset or the default Charset if the given Charset is null.

Parameters

charset:Charset: A charset or null.

Returns:Charset

the given Charset or the default Charset if the given Charset is null

toCharset	back to summary
public static Charset toCharset(final String charset) Returns a Charset for the named charset. If the name is null, return the default Charset. Parameters charset:String The name of the requested charset, may be null. Returns:Charset a Charset for the named charset Exceptions UnsupportedCharsetException: If the named charset is unavailable IllegalCharsetNameException: If the given charset name is illegal

toCharset

back to summary

public static Charset toCharset(final String charset)

Returns a Charset for the named charset. If the name is null, return the default Charset.

Parameters

charset:String: The name of the requested charset, may be null.

Returns:Charset

a Charset for the named charset

Exceptions

UnsupportedCharsetException:: If the named charset is unavailable
IllegalCharsetNameException:: If the given charset name is illegal

public Class Charsets

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail