com.google.gdata.data.contacts

Class Relation

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.contacts.Relation

All Implemented Interfaces:

Extension

public class Relation
extends AbstractExtension

Contact's relation.

Nested Class Summary

Nested Classes

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

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

AbstractExtension.AttributesHandler

Field Summary

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

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Relation() Default mutable constructor.
Relation(String label, Relation.Rel rel, String value) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
boolean	equals(Object obj)
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
String	getLabel() Returns the label.
Relation.Rel	getRel() Returns the relation type.
String	getValue() Returns the value.
int	hashCode()
boolean	hasLabel() Returns whether it has the label.
boolean	hasRel() Returns whether it has the relation type.
boolean	hasValue() Returns whether it has the value.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setLabel(String label) Sets the label.
void	setRel(Relation.Rel rel) Sets the relation type.
void	setValue(String value) Sets the value.
String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Relation

public Relation()

Default mutable constructor.

Relation

public Relation(String label,
        Relation.Rel rel,
        String value)

Immutable constructor.

Parameters:

label - label.

rel - relation type.

value - value.

Method Detail

getLabel

public String getLabel()

Returns the label.

Returns:

label

setLabel

public void setLabel(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 Relation.Rel getRel()

Returns the relation type.

Returns:

relation type

setRel

public void setRel(Relation.Rel rel)

Sets the relation type.

Parameters:

rel - relation type or null to reset

hasRel

public boolean hasRel()

Returns whether it has the relation type.

Returns:

whether it has the relation type

getValue

public String getValue()

Returns the value.

Returns:

value

setValue

public void setValue(String value)

Sets the value.

Parameters:

value - value or null to reset

hasValue

public boolean hasValue()

Returns whether it has the value.

Returns:

whether it has the value

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object