biweekly.property

Class Attachment

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.Attachment

public class Attachment
extends ICalProperty

Defines a binary resource that is associated with the component to which it belongs (such as an image or document).

Code sample:

 VEvent event = new VEvent();
 
 //from a byte array
 byte[] data = ...
 Attachment attach = new Attachment("image/png", data);
 event.addAttachment(attach);
 
 //from a file 
 File file = new File("image.png");
 attach = new Attachment("image/png", file);
 event.addAttachment(attach);
 
 //referencing a URL
 attach = new Attachment("image/png", "http://example.com/image.png");
 event.addAttachment(attach);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.80-1, RFC 2445 p.77-8, vCal 1.0 p.25

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Attachment(String formatType, byte[] data) Creates a new attachment.
Attachment(String formatType, File file) Creates a new attachment.
Attachment(String formatType, String uri) Creates a new attachment.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentId() Gets the attachment's content ID.
byte[]	getData() Gets the attachment's binary data.
String	getFormatType() Gets the content-type of the property's value.
String	getUri() Gets the attachment's URI.
void	setContentId(String contentId) Assigns a content ID to the attachment's value.
void	setData(byte[] data) Assigns binary data to the attachment's value.
void	setFormatType(String formatType) Sets the content-type of the property's value.
void	setUri(String uri) Assigns a URI to the attachment's value.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attachment

public Attachment(String formatType,
          File file)
           throws IOException

Creates a new attachment.

Parameters:

formatType - the content-type of the data (e.g. "image/png")

file - the file to attach

Throws:

IOException - if there's a problem reading from the file

Attachment

public Attachment(String formatType,
          byte[] data)

Creates a new attachment.

Parameters:

formatType - the content-type of the data (e.g. "image/png")

data - the binary data

Attachment

public Attachment(String formatType,
          String uri)

Creates a new attachment.

Parameters:

formatType - the content-type of the data (e.g. "image/png")

uri - a URL pointing to the resource (e.g. "http://example.com/image.png")

Method Detail

getData

public byte[] getData()

Gets the attachment's binary data.

Returns:

the binary data or null if not set

setData

public void setData(byte[] data)

Assigns binary data to the attachment's value.

Parameters:

data - the binary data

getUri

public String getUri()

Gets the attachment's URI.

Returns:

the URI (e.g. "http://example.com/image.png") or null if not set

setUri

public void setUri(String uri)

Assigns a URI to the attachment's value.

Parameters:

uri - the URI (e.g. "http://example.com/image.png")

getContentId

public String getContentId()

Gets the attachment's content ID.

Returns:

the content ID

setContentId

public void setContentId(String contentId)

Assigns a content ID to the attachment's value.

Parameters:

contentId - the content ID

getFormatType

public String getFormatType()

Description copied from class: ICalProperty

Gets the content-type of the property's value.

Returns:

the content type (e.g. "image/png") or null if not set

See Also:

RFC 5545 p.19-20

setFormatType

public void setFormatType(String formatType)

Description copied from class: ICalProperty

Sets the content-type of the property's value.

Parameters:

formatType - the content type (e.g. "image/png") or null to remove

See Also:

RFC 5545 p.19-20

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to