Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.parameter

public Class Encoding

extends Parameter
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.Content, .Encodable, .Parameter, .ParameterFactory, net.fortuna.ical4j.util.Strings

$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...>
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final Encoding
BASE64

Base64 encoding.

public static final Encoding
BINARY

Binary encoding.

public static final Encoding
EIGHT_BIT

8 bit encoding.

public static final Encoding
QUOTED_PRINTABLE

Quoted printable encoding.

private static final long
public static final Encoding
SEVEN_BIT

7 bit encoding.

private final String
private static final String
private static final String
private static final String
private static final String
private static final String
Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
Encoding(final String
a string representation of an Inline Encoding
aValue
)

Method Summary

Modifier and TypeMethod and Description
public final String
Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

Field Detail

BASE64back to summary
public static final Encoding BASE64

Base64 encoding.

BINARYback to summary
public static final Encoding BINARY

Binary encoding.

EIGHT_BITback to summary
public static final Encoding EIGHT_BIT

8 bit encoding.

QUOTED_PRINTABLEback to summary
public static final Encoding QUOTED_PRINTABLE

Quoted printable encoding.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

SEVEN_BITback to summary
public static final Encoding SEVEN_BIT

7 bit encoding.

valueback to summary
private final String value
VALUE_BASE64back to summary
private static final String VALUE_BASE64
VALUE_BINARYback to summary
private static final String VALUE_BINARY
VALUE_EIGHT_BITback to summary
private static final String VALUE_EIGHT_BIT
VALUE_QUOTED_PRINTABLEback to summary
private static final String VALUE_QUOTED_PRINTABLE
VALUE_SEVEN_BITback to summary
private static final String VALUE_SEVEN_BIT

Constructor Detail

Encodingback to summary
public Encoding(final String aValue)
Parameters
aValue:String

a string representation of an Inline Encoding

Method Detail

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
net.fortuna.ical4j.model.parameter back to summary

public Class Encoding.Factory

extends Factory
implements ParameterFactory<Encoding>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ParameterFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Encoding
createParameter(final String
a value to assign to the returned parameter
value
)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createParameterback to summary
public Encoding createParameter(final String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:Encoding

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override