com.google.gdata.data.contacts

Class Event

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.contacts.Event

All Implemented Interfaces:

Extension

public class Event
extends ExtensionPoint

Contact's events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Rel Event type.

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Event() Default mutable constructor.
Event(java.lang.String label, java.lang.String rel) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
java.lang.String	getLabel() Returns the label.
java.lang.String	getRel() Returns the event type.
When	getWhen() Returns the time period description.
boolean	hasLabel() Returns whether it has the label.
boolean	hasRel() Returns whether it has the event type.
boolean	hasWhen() Returns whether it has the time period description.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setLabel(java.lang.String label) Sets the label.
void	setRel(java.lang.String rel) Sets the event type.
void	setWhen(When when) Sets the time period description.
java.lang.String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Default mutable constructor.

Event

public Event(java.lang.String label,
     java.lang.String rel)

Immutable constructor.

Parameters:

label - label.

rel - event type.

Method Detail

declareExtensions

public void declareExtensions(ExtensionProfile extProfile)

Description copied from class: ExtensionPoint

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Overrides:

declareExtensions in class ExtensionPoint

Parameters:

extProfile - the ExtensionProfile to initialize.

getLabel

public java.lang.String getLabel()

Returns the label.

Returns:

label

setLabel

public void setLabel(java.lang.String label)

Sets the label.

Parameters:

label - label or null to reset

hasLabel

public boolean hasLabel()

Returns whether it has the label.

Returns:

whether it has the label

getRel

public java.lang.String getRel()

Returns the event type.

Returns:

event type

setRel

public void setRel(java.lang.String rel)

Sets the event type.

Parameters:

rel - event type or null to reset

hasRel

public boolean hasRel()

Returns whether it has the event type.

Returns:

whether it has the event type

getWhen

public When getWhen()

Returns the time period description.

Returns:

time period description

setWhen

public void setWhen(When when)

Sets the time period description.

Parameters:

when - time period description or null to reset

hasWhen

public boolean hasWhen()

Returns whether it has the time period description.

Returns:

whether it has the time period description

validate

protected void validate()

Description copied from class: AbstractExtension

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.

Overrides:

validate in class AbstractExtension

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean required,
                                         boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters:

required - whether it is required

repeatable - whether it is repeatable

Returns:

extension description

putAttributes

protected void putAttributes(AttributeGenerator generator)

Description copied from class: AbstractExtension

Puts attributes into the attribute generator. Called from AbstractExtension.generate(XmlWriter,ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

putAttributes in class AbstractExtension

Parameters:

generator - attribute generator

consumeAttributes

protected void consumeAttributes(AttributeHelper helper)
                          throws ParseException

Description copied from class: AbstractExtension

Consumes attributes from the attribute helper. May also use AttributeHelper.consumeContent(boolean) to consume the element's text content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

consumeAttributes in class AbstractExtension

Parameters:

helper - attribute helper

Throws:

ParseException - any parsing exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object