org.apache.commons.compress.archivers.zip

Class NioZipEncoding

java.lang.Object

org.apache.commons.compress.archivers.zip.NioZipEncoding

All Implemented Interfaces:

ZipEncoding

class NioZipEncoding
extends java.lang.Object
implements ZipEncoding

A ZipEncoding, which uses a java.nio Charset to encode names.

This implementation works for all cases under java-1.5 or later. However, in java-1.4, some charsets don't have a java.nio implementation, most notably the default ZIP encoding Cp437.

The methods of this class are reentrant.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset

Constructor Summary

Constructors

Constructor and Description
NioZipEncoding(java.nio.charset.Charset charset) Construct an NIO based zip encoding, which wraps the given charset.

Method Summary

Modifier and Type	Method and Description
boolean	canEncode(java.lang.String name) Check, whether the given string may be losslessly encoded using this encoding.
java.lang.String	decode(byte[] data)
java.nio.ByteBuffer	encode(java.lang.String name) Encode a filename or a comment to a byte array suitable for storing it to a serialized zip entry.

Methods inherited from class java.lang.Object

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

Field Detail

charset

private final java.nio.charset.Charset charset

Constructor Detail

NioZipEncoding

public NioZipEncoding(java.nio.charset.Charset charset)

Construct an NIO based zip encoding, which wraps the given charset.

Parameters:

charset - The NIO charset to wrap.

Method Detail

canEncode

public boolean canEncode(java.lang.String name)

Description copied from interface: ZipEncoding

Check, whether the given string may be losslessly encoded using this encoding.

Specified by:

canEncode in interface ZipEncoding

Parameters:

name - A filename or ZIP comment.

Returns:

Whether the given name may be encoded with out any losses.

See Also:

ZipEncoding.canEncode(java.lang.String)

encode

public java.nio.ByteBuffer encode(java.lang.String name)

Description copied from interface: ZipEncoding

Encode a filename or a comment to a byte array suitable for storing it to a serialized zip entry.

Examples for CP 437 (in pseudo-notation, right hand side is C-style notation):

  encode("?_for_Dollar.txt") = "%U20AC_for_Dollar.txt"
  encode("Ölfässer.txt") = "\231lf\204sser.txt"
 

Specified by:

encode in interface ZipEncoding

Parameters:

name - A filename or ZIP comment.

Returns:

A byte buffer with a backing array containing the encoded name. Unmappable characters or malformed character sequences are mapped to a sequence of utf-16 words encoded in the format %Uxxxx. It is assumed, that the byte buffer is positioned at the beginning of the encoded result, the byte buffer has a backing array and the limit of the byte buffer points to the end of the encoded result.

See Also:

ZipEncoding.encode(java.lang.String)

decode

public java.lang.String decode(byte[] data)
                        throws java.io.IOException

Specified by:

decode in interface ZipEncoding

Parameters:

data - The byte values to decode.

Returns:

The decoded string.

Throws:

java.io.IOException - on error

See Also:

ZipEncoding.decode(byte[])