Package org.apache.commons.compress.archivers.zip

Class ZipEncodingHelper

java.lang.Object

org.apache.commons.compress.archivers.zip.ZipEncodingHelper

public abstract class ZipEncodingHelper
extends Object

Static helper functions for robustly encoding file names in ZIP files.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final ZipEncoding	ZIP_ENCODING_UTF_8	UTF-8.

Constructor Summary

Constructors

Constructor	Description
ZipEncodingHelper()

Method Summary

Modifier and Type	Method	Description
static ZipEncoding	getZipEncoding(String name)	Instantiates a ZIP encoding.
static ZipEncoding	getZipEncoding(Charset charset)	Instantiates a ZIP encoding.
(package private) static ByteBuffer	growBufferBy(ByteBuffer buffer, int increment)
(package private) static boolean	isUTF8(Charset charset)	Tests whether a given encoding is UTF-8.
private static boolean	isUTF8Alias(String name)	Tests whether the given non-null charset name is a UTF-8 alias.
private static Charset	toSafeCharset(String name)	Returns a Charset for the named charset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ZIP_ENCODING_UTF_8

static final ZipEncoding ZIP_ENCODING_UTF_8

UTF-8.

Constructor Details

ZipEncodingHelper

public ZipEncodingHelper()

Method Details

getZipEncoding

public static ZipEncoding getZipEncoding(Charset charset)

Instantiates a ZIP encoding. An NIO based character set encoder/decoder will be returned. As a special case, if the character set is UTF-8, the NIO encoder will be configured replace malformed and unmappable characters with '?'. This matches existing behavior from the older fallback encoder.

If the requested character set cannot be found, the platform default will be used instead.

Parameters:

charset - The charset of the ZIP encoding. Specify null for the platform's default encoding.

Returns:

A ZIP encoding for the given encoding name.

Since:

1.26.0

getZipEncoding

public static ZipEncoding getZipEncoding(String name)

Instantiates a ZIP encoding. An NIO based character set encoder/decoder will be returned. As a special case, if the character set is UTF-8, the NIO encoder will be configured replace malformed and unmappable characters with '?'. This matches existing behavior from the older fallback encoder.

If the requested character set cannot be found, the platform default will be used instead.

Parameters:

name - The name of the ZIP encoding. Specify null for the platform's default encoding.

Returns:

A ZIP encoding for the given encoding name.

growBufferBy

static ByteBuffer growBufferBy(ByteBuffer buffer,
 int increment)

isUTF8

static boolean isUTF8(Charset charset)

Tests whether a given encoding is UTF-8. If the given name is null, then check the platform's default encoding.

Parameters:

charset - If the given charset is null, then check the platform's default encoding.

isUTF8Alias

private static boolean isUTF8Alias(String name)

Tests whether the given non-null charset name is a UTF-8 alias.

Parameters:

name - a non-null charset name.

Returns:

whether the given non-null charset name is a UTF-8 alias.

toSafeCharset

private static Charset toSafeCharset(String name)

Returns a Charset for the named charset. If the name cannot find a charset, return Charset.defaultCharset().

Parameters:

name - The name of the requested charset, may be null.

Returns:

a Charset for the named charset.

See Also:

• Charset.defaultCharset()