jfxtras.icalendarfx.properties.component.descriptive

Class Attachment<T>

java.lang.Object

jfxtras.icalendarfx.VParentBase

jfxtras.icalendarfx.properties.PropertyBase<T,Attachment<T>>

jfxtras.icalendarfx.properties.component.descriptive.Attachment<T>

All Implemented Interfaces:

java.lang.Comparable<Property<T>>, PropAttachment<T>, Property<T>, VChild, VElement, VParent

public class Attachment<T>
extends PropertyBase<T,Attachment<T>>
implements PropAttachment<T>

<p>Property Name: ATTACH</p>

<p>Purpose:  This property provides the capability to associate a
   document object with a calendar component.</p>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>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".</p>

<p>Format Definition:  This property is defined by the following notation:
<ul>
<li>attach
  <ul>
  <li>ATTACH attachparam ( ":" uri )
    <ul>
    <li>";" ENCODING "=" BASE64
    <li>";" VALUE "=" BINARY
    <li>":" binary
    <li>CRLF
    </ul>
  </ul>
<li>attachparam
  <ul>
  <li>The following is OPTIONAL for a URI value, RECOMMENDED for a BINARY value, and MUST NOT occur more than once.
    <ul>
    <li>";" fmttypeparam
    </ul>
  <li>The following are OPTIONAL, and MAY occur more than once.
    <ul>
    <li>";" OtherParameter
    </ul>
  </ul>
</ul>

<p>Example:  The following is an example of this property:
<ul>
<li>ATTACH:CID:jsmith.part3.960817T083000.xyzMail@example.com
<li>ATTACH;FMTTYPE=application/postscript:ftp://example.com/pub/<br>
      reports/r-960812.ps
</ul>
</p>
3.8.1.1.  Attachment  RFC 5545                       iCalendar                  September 2009

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<Encoding>	encoding
javafx.beans.property.ObjectProperty<FormatType>	formatType

Properties inherited from class jfxtras.icalendarfx.properties.PropertyBase

propertyNameProperty, valueProperty, valueTypeProperty

Properties inherited from interface jfxtras.icalendarfx.properties.Property

valueProperty, valueTypeProperty

Constructor Summary

Constructors

Constructor and Description
Attachment(Attachment<T> source) Create deep copy of source Attachment
Attachment(java.lang.Class<T> clazz, java.lang.String contentLine) Create a Binary Attachment by setting property value to String input parameter
Attachment(T value) Create new Attendee with property value set to input parameter<br> Note: This constructor has no type checking.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<Encoding>	encodingProperty()
java.util.List<java.lang.String>	errors() Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
javafx.beans.property.ObjectProperty<FormatType>	formatTypeProperty()
Encoding	getEncoding() ENCODING: Incline Encoding RFC 5545, 3.2.7, page 18
FormatType	getFormatType() FMTTYPE: Format type parameter RFC 5545, 3.2.8, page 19 specify the content type of a referenced object.
static <U> Attachment<U>	parse(java.lang.String string) Create new Attachment by parsing unfolded calendar content
protected void	setConverterByClass(java.lang.Class<T> clazz)
void	setEncoding(Encoding encoding)
void	setFormatType(FormatType formatType)
Attachment<T>	withEncoding(Encoding.EncodingType encoding)
Attachment<T>	withEncoding(Encoding encoding)
Attachment<T>	withFormatType(FormatType format)
Attachment<T>	withFormatType(java.lang.String format)

Methods inherited from class jfxtras.icalendarfx.properties.PropertyBase

compareTo, copyInto, copyValue, equals, getConverter, getNonStandard, getParent, getPropertyValueString, getUnknownValue, getValue, getValueType, hashCode, name, nonStandardParameter, parseContent, propertyNameProperty, propertyType, setConverter, setNonStandard, setParent, setPropertyName, setValue, setValueType, setValueType, setValueType, toContent, toString, valueContent, valueProperty, valueTypeProperty, withNonStandard, withNonStandard, withNonStandard, withPropertyName, withValue, withValueType, withValueType

Methods inherited from class jfxtras.icalendarfx.VParentBase

childrenUnmodifiable, copyIntoCallback, orderer, setContentLineGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface jfxtras.icalendarfx.properties.Property

getNonStandard, getValue, getValueType, nonStandardParameter, propertyType, setNonStandard, setValue, setValueType, valueProperty, valueTypeProperty

Methods inherited from interface jfxtras.icalendarfx.VParent

childrenUnmodifiable, copyInto

Methods inherited from interface jfxtras.icalendarfx.VChild

getParent, setParent

Methods inherited from interface jfxtras.icalendarfx.VElement

isValid, name, parseContent, toContent

Methods inherited from interface java.lang.Comparable

compareTo

Property Detail

formatType

public javafx.beans.property.ObjectProperty<FormatType> formatTypeProperty

Specified by:

formatTypeProperty in interface PropAttachment<T>

See Also:

getFormatType(), setFormatType(FormatType)

encoding

public javafx.beans.property.ObjectProperty<Encoding> encodingProperty

Specified by:

encodingProperty in interface PropAttachment<T>

See Also:

getEncoding(), setEncoding(Encoding)

Constructor Detail

Attachment

public Attachment(java.lang.Class<T> clazz,
                  java.lang.String contentLine)

Create a Binary Attachment by setting property value to String input parameter

Attachment

public Attachment(Attachment<T> source)

Create deep copy of source Attachment

Attachment

public Attachment(T value)

Create new Attendee with property value set to input parameter<br> Note: This constructor has no type checking. Use Attachment(Class, String) constructor for type checking

Method Detail

getFormatType

public FormatType getFormatType()

FMTTYPE: Format type parameter RFC 5545, 3.2.8, page 19 specify the content type of a referenced object.

Specified by:

getFormatType in interface PropAttachment<T>

formatTypeProperty

public javafx.beans.property.ObjectProperty<FormatType> formatTypeProperty()

Specified by:

formatTypeProperty in interface PropAttachment<T>

See Also:

getFormatType(), setFormatType(FormatType)

setFormatType

public void setFormatType(FormatType formatType)

Specified by:

setFormatType in interface PropAttachment<T>

withFormatType

public Attachment<T> withFormatType(FormatType format)

withFormatType

public Attachment<T> withFormatType(java.lang.String format)

getEncoding

public Encoding 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 interface PropAttachment<T>

encodingProperty

public javafx.beans.property.ObjectProperty<Encoding> encodingProperty()

Specified by:

encodingProperty in interface PropAttachment<T>

See Also:

getEncoding(), setEncoding(Encoding)

setEncoding

public void setEncoding(Encoding encoding)

Specified by:

setEncoding in interface PropAttachment<T>

withEncoding

public Attachment<T> withEncoding(Encoding encoding)

withEncoding

public Attachment<T> withEncoding(Encoding.EncodingType encoding)

setConverterByClass

protected void setConverterByClass(java.lang.Class<T> clazz)

Overrides:

setConverterByClass in class PropertyBase<T,Attachment<T>>

errors

public java.util.List<java.lang.String> errors()

Description copied from interface: VElement

Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent

Specified by:

errors in interface VElement

Overrides:

errors in class PropertyBase<T,Attachment<T>>

Returns:

parse

public static <U> Attachment<U> parse(java.lang.String string)

Create new Attachment by parsing unfolded calendar content