Class Attachment<T>
- All Implemented Interfaces:
PropAttachment<T>
,VProperty<T>
,VChild
,VElement
,VParent
Property Name: ATTACH
Purpose: This property provides the capability to associate a document object with a calendar component.
Value Type: The default value type
for this property is URI
. The
value type can also be set to BINARY
to indicate inline binary
encoded content information.
Property Parameters: IANA, non-standard
,
inline encoding
, and value
data type property
parameters can be specified on this property.
The format type parameter
can be specified on this property and is
RECOMMENDED for inline binary encoded content information.
Conformance: This property can be specified multiple times in a
VEVENT
, VTODO
, VJOURNAL
, or VALARM
calendar component with
the exception of AUDIO alarm that only allows this property to
occur once.
Description: This property is used in VEVENT
, VTODO
, and
VJOURNAL
calendar components to associate a resource (e.g.,
document) with the calendar component. This property is used in
VALARM
calendar components to specify an audio sound resource or
an email message attachment. This property can be specified as a
URI pointing to a resource or as inline binary encoded content.
When this property is specified as inline binary encoded content,
calendar applications MAY attempt to guess the media type of the
resource via inspection of its content if and only if the media
type of the resource is not given by the FMTTYPE
parameter. If
the media type remains unknown, calendar applications SHOULD treat
it as type "application/octet-stream".
Format Definition: This property is defined by the following notation:
- attach
- attachparam
- The following is OPTIONAL for a URI value, RECOMMENDED for a BINARY value, and MUST NOT occur more than once.
- ";"
fmttypeparam
- ";"
- The following are OPTIONAL, and MAY occur more than once.
- ";"
OtherParameter
- ";"
- The following is OPTIONAL for a URI value, RECOMMENDED for a BINARY value, and MUST NOT occur more than once.
Example: The following is an example of this property:
- ATTACH:CID:jsmith.part3.960817T083000.xyzMail@example.com
- ATTACH;FMTTYPE=application/postscript:ftp://example.com/pub/
reports/r-960812.ps
-
Nested Class Summary
Nested classes/interfaces inherited from class jfxtras.icalendarfx.VElementBase
VElementBase.Message, VElementBase.MessageEffect
-
Field Summary
FieldsFields inherited from class jfxtras.icalendarfx.properties.VPropertyBase
actualValueContent, allowedValueTypes, defaultValueType, propertyName
Fields inherited from class jfxtras.icalendarfx.VParentBase
contentLineGenerator, orderer
Fields inherited from class jfxtras.icalendarfx.VElementBase
BEGIN, END
-
Constructor Summary
ConstructorsConstructorDescriptionCreate default Attachment with no value setAttachment
(Class<T> clazz, String contentLine) Create a Binary Attachment by setting property value to String input parameterAttachment
(Attachment<T> source) Create deep copy of source AttachmentAttachment
(T value) Create new Attendee with property value set to input parameter
Note: This constructor has no type checking. -
Method Summary
Modifier and TypeMethodDescriptionerrors()
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parentENCODING: Incline Encoding RFC 5545, 3.2.7, page 18 Specify an alternate inline encoding for the property value.FMTTYPE: Format type parameter RFC 5545, 3.2.8, page 19 specify the content type of a referenced object.static <U> Attachment<U>
protected void
setConverterByClass
(Class<T> clazz) void
setEncoding
(Encoding encoding) void
setFormatType
(FormatType formatType) withEncoding
(Encoding encoding) withEncoding
(Encoding.EncodingType encoding) withFormatType
(String format) withFormatType
(FormatType format) Methods inherited from class jfxtras.icalendarfx.properties.VPropertyBase
copyValue, equals, getConverter, getNonStandard, getParent, getUnknownValue, getValue, getValueType, hashCode, modifiedValue, name, parseContent, processInLineChild, setConverter, setNonStandard, setParent, setValue, setValueType, setValueType, toString, valueContent, withNonStandard, withNonStandard, withNonStandard, withValue, withValueType
Methods inherited from class jfxtras.icalendarfx.VParentBase
addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, removeChild, removeChild, replaceChild, replaceChild, withChild
Methods inherited from class jfxtras.icalendarfx.VElementBase
elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface jfxtras.icalendarfx.VParent
addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild
Methods inherited from interface jfxtras.icalendarfx.properties.VProperty
getNonStandard, getValue, getValueType, setNonStandard, setValue, setValueType
-
Field Details
-
formatType
-
encoding
-
-
Constructor Details
-
Attachment
Create a Binary Attachment by setting property value to String input parameter -
Attachment
Create deep copy of source Attachment -
Attachment
Create new Attendee with property value set to input parameter
Note: This constructor has no type checking. UseAttachment(Class, String)
constructor for type checking -
Attachment
public Attachment()Create default Attachment with no value set
-
-
Method Details
-
getFormatType
FMTTYPE: Format type parameter RFC 5545, 3.2.8, page 19 specify the content type of a referenced object.- Specified by:
getFormatType
in interfacePropAttachment<T>
-
setFormatType
- Specified by:
setFormatType
in interfacePropAttachment<T>
-
withFormatType
-
withFormatType
-
getEncoding
ENCODING: Incline Encoding RFC 5545, 3.2.7, page 18 Specify an alternate inline encoding for the property value. Values can be "8BIT" text encoding defined in [RFC2045] "BASE64" binary encoding format defined in [RFC4648] If the value type parameter is ";VALUE=BINARY", then the inline encoding parameter MUST be specified with the value" ;ENCODING=BASE64".- Specified by:
getEncoding
in interfacePropAttachment<T>
-
setEncoding
- Specified by:
setEncoding
in interfacePropAttachment<T>
-
withEncoding
-
withEncoding
-
setConverterByClass
- Overrides:
setConverterByClass
in classVPropertyBase<T,
Attachment<T>>
-
errors
Description copied from interface:VElement
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parent- Specified by:
errors
in interfaceVElement
- Overrides:
errors
in classVPropertyBase<T,
Attachment<T>> - Returns:
- - list of error messages
-
parse
-