net.java.truelicense.core.codec

Class Codecs

java.lang.Object

net.java.truelicense.core.codec.Codecs

public class Codecs
extends Object

Provides common Codec functions.

Author:

Christian Schlichtherle

Method Summary

Modifier and Type	Method and Description
static Charset	charset(Codec codec) Figures the content transfer charset which is used by the given codec.
static <T> T	clone(T object) Returns a clone of the given object using a new SerializationCodec.
static <T> T	clone(T object, Codec codec) Returns a clone of the given object using the given codec.
static Charset	contentTransferCharset(Codec codec) Figures the content transfer charset which is used by the given codec.

Methods inherited from class java.lang.Object

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

Method Detail

charset

@CheckForNull
public static Charset charset(Codec codec)

Figures the content transfer charset which is used by the given codec. This method passes the call to contentTransferCharset(net.java.truelicense.core.codec.Codec). If an IllegalArgumentException is thrown, then it returns null.

Parameters:

codec - the codec to test.

Returns:

The content transfer charset which is used by the given codec or null if the codec doesn't produce text or specifies an invalid charset name or an unknown charset.

clone

public static <T> T clone(T object)
                   throws Exception

Returns a clone of the given object using a new SerializationCodec.

Throws:

Exception

Since:

TrueLicense 2.5

clone

public static <T> T clone(T object,
                          Codec codec)
                   throws Exception

Returns a clone of the given object using the given codec.

Throws:

Exception

Since:

TrueLicense 2.5

contentTransferCharset

public static Charset contentTransferCharset(Codec codec)

Figures the content transfer charset which is used by the given codec.

1. First, the codec's Content-Transfer-Encoding gets tested: If it is "7bit", "quoted-printable" or "base64" (ignoring case), then the returned charset is US-ASCII.
2. Otherwise, if the codec's Content-Transfer-Encoding is "8bit" (ignoring case), then the codec's Content-Type gets tested:
   1. If the codec's Content-Type specifies a charset parameter (ignoring case), then an attempt is made to load this charset. Upon success, this charset gets returned.
   2. If the codec's Content-Type does not specify a charset parameter, then UTF-8 gets returned. This ensures compatibility with JSON.
3. Finally, in all other cases, an IllegalArgumentException gets thrown in order to specify that the codec doesn't produce text or specifies an invalid charset name or an unknown charset.

Parameters:

codec - the codec to test.

Returns:

The content transfer charset which is used by the given codec.

Throws:

IllegalCharsetNameException - if the specified charset name is invalid.

UnsupportedCharsetException - if the specified charset is unknown.

BinaryCodecException - if the codec doesn't produce text.

Since:

TrueLicense 2.2.1