Module ical4j.core

Package net.fortuna.ical4j.model.parameter

Class Encoding

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Parameter

net.fortuna.ical4j.model.parameter.Encoding

All Implemented Interfaces:

Serializable, Comparable<Parameter>, Encodable

public class Encoding
extends Parameter
implements Encodable

$Id$ [18-Apr-2004]

Defines an Inline Encoding parameter. Constants are provided for all encodings specified in RFC2045.

  4.2.7 Inline Encoding

     Parameter Name: ENCODING

     Purpose: To specify an alternate inline encoding for the property
     value.

     Format Definition: The property parameter is defined by the following
     notation:

       encodingparam      = "ENCODING" "="
                            ("8BIT"
          ; "8bit" text encoding is defined in [RFC 2045]
                          / "BASE64"
          ; "BASE64" binary encoding format is defined in [RFC 2045]
                          / iana-token
          ; Some other IANA registered iCalendar encoding type
                          / x-name)
          ; A non-standard, experimental encoding type

     Description: The property parameter identifies the inline encoding
     used in a property value. The default encoding is "8BIT",
     corresponding to a property value consisting of text. The "BASE64"
     encoding type corresponds to a property value encoded using the
     "BASE64" encoding defined in [RFC 2045].

     If the value type parameter is ";VALUE=BINARY", then the inline
     encoding parameter MUST be specified with the value
     ";ENCODING=BASE64".

     Example:

       ATTACH;FMTYPE=IMAGE/JPEG;ENCODING=BASE64;VALUE=BINARY:MIICajC
        CAdOgAwIBAgICBEUwDQYJKoZIhvcNAQEEBQAwdzELMAkGA1UEBhMCVVMxLDA
        qBgNVBAoTI05ldHNjYXBlIENvbW11bmljYXRpb25zIENvcnBvcmF0aW9uMRw
        <...remainder of "BASE64" encoded binary data...>
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Encoding.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Encoding	BASE64	Base64 encoding.
static final Encoding	BINARY	Binary encoding.
static final Encoding	EIGHT_BIT	8 bit encoding.
static final Encoding	QUOTED_PRINTABLE	Quoted printable encoding.
static final Encoding	SEVEN_BIT	7 bit encoding.

Fields inherited from class net.fortuna.ical4j.model.Parameter

ABBREV, ALTREP, CN, CUTYPE, DELEGATED_FROM, DELEGATED_TO, DERIVED, DIR, DISPLAY, EMAIL, ENCODING, EXPERIMENTAL_PREFIX, FBTYPE, FEATURE, FMTTYPE, LABEL, LANGUAGE, MEMBER, ORDER, PARTSTAT, RANGE, RELATED, RELTYPE, ROLE, RSVP, SCHEDULE_AGENT, SCHEDULE_STATUS, SCHEMA, SENT_BY, TYPE, TZID, VALUE, VVENUE

Constructor Summary

Constructors

Constructor	Description
Encoding(String aValue)

Method Summary

Modifier and Type	Method	Description
final String	getValue()

Methods inherited from class net.fortuna.ical4j.model.Parameter

compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SEVEN_BIT

public static final Encoding SEVEN_BIT

7 bit encoding.

EIGHT_BIT

public static final Encoding EIGHT_BIT

8 bit encoding.

BINARY

public static final Encoding BINARY

Binary encoding.

QUOTED_PRINTABLE

public static final Encoding QUOTED_PRINTABLE

Quoted printable encoding.

BASE64

public static final Encoding BASE64

Base64 encoding.

Constructor Details

Encoding

public Encoding(String aValue)

Parameters:

aValue - a string representation of an Inline Encoding

Method Details

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value