com.google.gdata.data.extensions

Class CustomProperty

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.extensions.CustomProperty

All Implemented Interfaces:

Extension

public class CustomProperty
extends AbstractExtension

Name-value pair with optional type and unit.

Nested Class Summary

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
CustomProperty() Default mutable constructor.
CustomProperty(java.lang.String name, java.lang.String type, java.lang.String unit, java.lang.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(java.lang.Object obj)
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
java.lang.String	getName() Returns the can be a URI to indicate a specific ontology.
java.lang.String	getType() Returns the datatype such as string, integer, and date, or an ontology-specific URI.
java.lang.String	getUnit() Returns the units of data - can also be a URI to indicate a specific ontology.
java.lang.String	getValue() Returns the value.
int	hashCode()
boolean	hasName() Returns whether it has the can be a URI to indicate a specific ontology.
boolean	hasType() Returns whether it has the datatype such as string, integer, and date, or an ontology-specific URI.
boolean	hasUnit() Returns whether it has the units of data - can also be a URI to indicate a specific ontology.
boolean	hasValue() Returns whether it has the value.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setName(java.lang.String name) Sets the can be a URI to indicate a specific ontology.
void	setType(java.lang.String type) Sets the datatype such as string, integer, and date, or an ontology-specific URI.
void	setUnit(java.lang.String unit) Sets the units of data - can also be a URI to indicate a specific ontology.
void	setValue(java.lang.String value) Sets the value.
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.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

CustomProperty

public CustomProperty()

Default mutable constructor.

CustomProperty

public CustomProperty(java.lang.String name,
              java.lang.String type,
              java.lang.String unit,
              java.lang.String value)

Immutable constructor.

Parameters:

name - can be a URI to indicate a specific ontology.

type - datatype such as string, integer, and date, or an ontology-specific URI.

unit - units of data - can also be a URI to indicate a specific ontology.

value - value.

Method Detail

getName

public java.lang.String getName()

Returns the can be a URI to indicate a specific ontology.

Returns:

can be a URI to indicate a specific ontology

setName

public void setName(java.lang.String name)

Sets the can be a URI to indicate a specific ontology.

Parameters:

name - can be a URI to indicate a specific ontology or null to reset

hasName

public boolean hasName()

Returns whether it has the can be a URI to indicate a specific ontology.

Returns:

whether it has the can be a URI to indicate a specific ontology

getType

public java.lang.String getType()

Returns the datatype such as string, integer, and date, or an ontology-specific URI.

Returns:

datatype such as string, integer, and date, or an ontology-specific URI

setType

public void setType(java.lang.String type)

Sets the datatype such as string, integer, and date, or an ontology-specific URI.

Parameters:

type - datatype such as string, integer, and date, or an ontology-specific URI or null to reset

hasType

public boolean hasType()

Returns whether it has the datatype such as string, integer, and date, or an ontology-specific URI.

Returns:

whether it has the datatype such as string, integer, and date, or an ontology-specific URI

getUnit

public java.lang.String getUnit()

Returns the units of data - can also be a URI to indicate a specific ontology.

Returns:

units of data - can also be a URI to indicate a specific ontology

setUnit

public void setUnit(java.lang.String unit)

Sets the units of data - can also be a URI to indicate a specific ontology.

Parameters:

unit - units of data - can also be a URI to indicate a specific ontology or null to reset

hasUnit

public boolean hasUnit()

Returns whether it has the units of data - can also be a URI to indicate a specific ontology.

Returns:

whether it has the units of data - can also be a URI to indicate a specific ontology

getValue

public java.lang.String getValue()

Returns the value.

Returns:

value

setValue

public void setValue(java.lang.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(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object