net.fortuna.ical4j.vcard.property

Class Key

java.lang.Object

net.fortuna.ical4j.vcard.Property

net.fortuna.ical4j.vcard.property.Key

All Implemented Interfaces:

java.io.Serializable

public final class Key
extends Property

KEY property.

$Id$

Created on 23/10/2008

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key.Factory

Nested classes/interfaces inherited from class net.fortuna.ical4j.vcard.Property

Property.Id

Field Summary

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

ILLEGAL_PARAMETER_MESSAGE

Constructor Summary

Constructors

Constructor and Description
Key(byte[] binary)
Key(byte[] binary, Type contentType)
Key(Group group, java.util.List<Parameter> params, java.lang.String value) Factory constructor.
Key(java.util.List<Parameter> params, java.lang.String value) Factory constructor.
Key(java.net.URI uri)

Method Summary

Modifier and Type	Method and Description
byte[]	getBinary()
java.lang.String	getValue()
void	validate()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key(java.net.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(java.util.List<Parameter> params,
           java.lang.String value)
    throws org.apache.commons.codec.DecoderException,
           java.net.URISyntaxException

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

java.net.URISyntaxException - where the specified string is not a valid URI

Key

public Key(Group group,
           java.util.List<Parameter> params,
           java.lang.String value)
    throws org.apache.commons.codec.DecoderException,
           java.net.URISyntaxException

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

java.net.URISyntaxException - where the specified string is not a valid URI

Method Detail

getBinary

public byte[] getBinary()

Returns:

the binary

getValue

public java.lang.String getValue()

Specified by:

getValue in class Property

Returns:

a string representaion of the property propertyName

validate

public void validate()
              throws net.fortuna.ical4j.model.ValidationException

Specified by:

validate in class Property

Throws:

net.fortuna.ical4j.model.ValidationException - where the property fails validation rules