biweekly.property

Class BinaryProperty

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.BinaryProperty

Direct Known Subclasses:

Attachment, Image

public class BinaryProperty
extends ICalProperty

A property whose value is a binary resource (such as an image or document).

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	data
protected String	uri

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
BinaryProperty(BinaryProperty original) Copy constructor.
BinaryProperty(byte[] data) Creates a new binary property.
BinaryProperty(File file) Creates a new binary property.
BinaryProperty(String uri) Creates a new binary property.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getData() Gets the property's binary data.
String	getFormatType() Gets the content-type of the property's value.
String	getUri() Gets the property's URI.
int	hashCode()
void	setData(byte[] data) Sets the property's binary data.
void	setFormatType(String formatType) Sets the content-type of the property's value.
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<Warning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

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

Field Detail

data

protected byte[] data

uri

protected String uri

Constructor Detail

BinaryProperty

public BinaryProperty(File file)
               throws IOException

Creates a new binary property.

Parameters:

file - a file containing the binary data

Throws:

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

BinaryProperty

public BinaryProperty(byte[] data)

Creates a new binary property.

Parameters:

data - the binary data

BinaryProperty

public BinaryProperty(String uri)

Creates a new binary property.

Parameters:

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

BinaryProperty

public BinaryProperty(BinaryProperty original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getData

public byte[] getData()

Gets the property's binary data.

Returns:

the binary data or null if not set

setData

public void setData(byte[] data)

Sets the property's binary data.

Parameters:

data - the binary data

getUri

public String getUri()

Gets the property's URI.

Returns:

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

setUri

public void setUri(String uri)

Sets the property's URI.

Parameters:

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

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

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 ICalProperty

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class ICalProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalProperty