com.adaptris.core.util

Enum EncodingHelper.Encoding

java.lang.Object

java.lang.Enum<EncodingHelper.Encoding>

com.adaptris.core.util.EncodingHelper.Encoding

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EncodingHelper.Encoding>

Enclosing class:

EncodingHelper

public static enum EncodingHelper.Encoding
extends java.lang.Enum<EncodingHelper.Encoding>

Standard supported encodings

Enum Constant Summary

Enum Constants

Enum Constant and Description
Base64
Basic_Base64 Base64 using the Basic type base64 encoding scheme.
MIME_Base64 Base64 using the MIME type base64 scheme.
None No Encoding.
Quoted_Printable 'quoted-printable' encoding MIME style.
URL_Base64 Base64 using URL and Filename safe type base64 scheme.
UUEncode 'uuencode' encoding MIME style.

Method Summary

Modifier and Type	Method and Description
static EncodingHelper.Encoding	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EncodingHelper.Encoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract java.io.InputStream	wrap(java.io.InputStream in)
abstract java.io.OutputStream	wrap(java.io.OutputStream out)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Base64

@ConfigDeprecated(removalVersion="4.0.0",
                  message="Use Base64_MIME / Base64_URL / Base64_Basic instead",
                  groups=java.lang.Deprecated.class)
public static final EncodingHelper.Encoding Base64

MIME_Base64

public static final EncodingHelper.Encoding MIME_Base64

Base64 using the MIME type base64 scheme.

Uses Base64 under the covers

Quoted_Printable

public static final EncodingHelper.Encoding Quoted_Printable

'quoted-printable' encoding MIME style.

Uses MimeUtility as the encoder / decoder.

UUEncode

public static final EncodingHelper.Encoding UUEncode

'uuencode' encoding MIME style.

Uses MimeUtility as the encoder / decoder.

URL_Base64

public static final EncodingHelper.Encoding URL_Base64

Base64 using URL and Filename safe type base64 scheme.

Uses Base64 under the covers

Basic_Base64

public static final EncodingHelper.Encoding Basic_Base64

Base64 using the Basic type base64 encoding scheme.

Uses Base64 under the covers

None

public static final EncodingHelper.Encoding None

No Encoding.

Method Detail

values

public static EncodingHelper.Encoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EncodingHelper.Encoding c : EncodingHelper.Encoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EncodingHelper.Encoding valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

wrap

public abstract java.io.OutputStream wrap(java.io.OutputStream out)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

wrap

public abstract java.io.InputStream wrap(java.io.InputStream in)
                                  throws java.lang.Exception

Throws:

java.lang.Exception