biweekly.property

Class Attachment

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.BinaryProperty

biweekly.property.Attachment

public class Attachment
extends BinaryProperty

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

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.BinaryProperty

data, uri

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Attachment(Attachment original) Copy constructor.
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
Attachment	copy() Creates a copy of this property object.
boolean	equals(Object obj)
String	getContentId() Sets the content ID.
int	hashCode()
void	setContentId(String contentId) Sets the content ID.
void	setData(byte[] data) Sets the property's binary data.
void	setUri(String uri) Sets the property's URI.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<ValidationWarning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.BinaryProperty

getData, getFormatType, getUri, setFormatType

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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")

Attachment

public Attachment(Attachment original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

setData

public void setData(byte[] data)

Description copied from class: BinaryProperty

Sets the property's binary data.

Overrides:

setData in class BinaryProperty

Parameters:

data - the binary data

setUri

public void setUri(String uri)

Description copied from class: BinaryProperty

Sets the property's URI.

Overrides:

setUri in class BinaryProperty

Parameters:

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

getContentId

public String getContentId()

Sets the content ID.

Returns:

the content ID or null if not set

setContentId

public void setContentId(String contentId)

Sets the content ID.

Parameters:

contentId - the content ID

validate

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

Description copied from class: ICalProperty

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

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 BinaryProperty

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

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalProperty

Gets string representations of the class's fields for the ICalProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class BinaryProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

public Attachment copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy

hashCode

public int hashCode()

Overrides:

hashCode in class BinaryProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class BinaryProperty