Package net.fortuna.ical4j.vcard.property

Class Key

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.vcard.GroupProperty

net.fortuna.ical4j.vcard.property.Key

All Implemented Interfaces:

Serializable, Comparable<Property>, FluentProperty

public class Key
extends GroupProperty

KEY property.

$Id$

Created on 23/10/2008

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Key.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.vcard.GroupProperty

ILLEGAL_PARAMETER_MESSAGE

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION

Constructor Summary

Constructors

Constructor	Description
Key(byte[] binary)
Key(byte[] binary, Type contentType)
Key(URI uri)
Key(ParameterList params, String value)	Factory constructor.
Key(Group group, ParameterList params, String value)	Factory constructor.

Method Summary

Modifier and Type	Method	Description
byte[]	getBinary()
String	getValue()
protected PropertyFactory<Key>	newFactory()
void	setValue(String value)
ValidationResult	validate()

Methods inherited from class net.fortuna.ical4j.vcard.GroupProperty

assertOneOrLess, assertParametersEmpty, assertPidParameter, assertPrefParameter, assertTextParameter, assertTypeParameter, equals, getGroup, getId, getParameter, hashCode, toString

Methods inherited from class net.fortuna.ical4j.model.Property

add, compareTo, copy, getFluentTarget, getName, getParameter, getParameterList, getParameters, getRequiredParameter, remove, removeAll, replace, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Detail

Key

public Key(URI uri)

Parameters:

uri - a key URI

Key

public Key(byte[] binary)

Parameters:

binary - binary key data

Key

public Key(byte[] binary,
           Type contentType)

Parameters:

binary - binary key data

contentType - key MIME type

Key

public Key(ParameterList params,
           String value)

Factory constructor.

Parameters:

params - property parameters

value - string representation of a property value

Throws:

org.apache.commons.codec.DecoderException - if the specified string is not a valid key encoding

URISyntaxException - where the specified string is not a valid URI

Key

public Key(Group group,
           ParameterList params,
           String value)

Factory constructor.

Parameters:

group - property group

params - property parameters

value - string representation of a property value

Throws:

org.apache.commons.codec.DecoderException - if the specified string is not a valid key encoding

URISyntaxException - where the specified string is not a valid URI

Method Detail

getBinary

public byte[] getBinary()

Returns:

the binary

getValue

public String getValue()

Specified by:

getValue in class Content

setValue

public void setValue(String value)

Specified by:

setValue in class Property

validate

public ValidationResult validate()
                          throws ValidationException

Specified by:

validate in class Property

Throws:

ValidationException

newFactory

protected PropertyFactory<Key> newFactory()

Specified by:

newFactory in class Property