Class Attach

  • All Implemented Interfaces:
    Serializable, Comparable<Property>

    public class Attach
    extends Property

    Created: [Apr 6, 2004]

    Defines an ATTACH iCalendar component property.

              Property Name: ATTACH
              Purpose: The 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: Non-standard, inline encoding, format type and
              value data type property parameters can be specified on this
              Conformance: The property can be specified in a "VEVENT", "VTODO",
              "VJOURNAL" or "VALARM" calendar components.
              Description: The property can be specified within "VEVENT", "VTODO",
              "VJOURNAL", or "VALARM" calendar components. This property can be
              specified multiple times within an iCalendar object.
              Format Definition: The property is defined by the following notation:
                attach     = "ATTACH" attparam ":" uri  CRLF
            attach     =/ "ATTACH" attparam ";" "ENCODING" "=" "BASE64"
                              ";" "VALUE" "=" "BINARY" ":" binary
                attparam   = *(
                           ; the following is optional,
                           ; but MUST NOT occur more than once
                           (";" fmttypeparam) /
                           ; the following is optional,
                           ; and MAY occur more than once
                           (";" xparam)
    See Also:
    Serialized Form
    • Constructor Detail

      • Attach

        public Attach()
        Default constructor.
      • Attach

        public Attach​(byte[] data)
        data - binary data
      • Attach

        public Attach​(ParameterList aList,
                      byte[] data)
        aList - a list of parameters for this component
        data - binary data
      • Attach

        public Attach​(URI aUri)
        aUri - a URI
      • Attach

        public Attach​(ParameterList aList,
                      URI aUri)
        aList - a list of parameters for this component
        aUri - a URI
    • Method Detail

      • getBinary

        public final byte[] getBinary()
        Returns the binary.
      • getUri

        public final URI getUri()
        Returns the uri.
      • setValue

        public final void setValue​(String aValue)
                            throws URISyntaxException
        Sets the current value of the Attach instance. If the specified value is encoded binary data, the value is decoded and stored in the binary field. Otherwise the value is assumed to be a URI location to binary data and is stored as such.
        Specified by:
        setValue in class Property
        aValue - a string encoded binary or URI value
        URISyntaxException - where the specified value is not a valid URI
      • getValue

        public final String getValue()
        Specified by:
        getValue in class Content
        the content value
      • setBinary

        public final void setBinary​(byte[] binary)
        binary - The binary to set.
      • setUri

        public final void setUri​(URI uri)
        uri - The uri to set.