com.google.gdata.model.gd
Class ExtendedProperty

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.gd.ExtendedProperty

public class ExtendedProperty
extends Element

Stores a limited amount of custom data as an auxiliary property of the enclosing entity.


Nested Class Summary
static class ExtendedProperty.Realm
          Limit on who may see and modify this extended property.
 
Field Summary
static ElementKey<java.lang.Void,ExtendedProperty> KEY
          The key for this element.
static AttributeKey<java.lang.String> NAME
          Name of the property expressed as a URI.
static AttributeKey<java.lang.String> REALM
          Limit on who may see and modify this extended property.
static AttributeKey<java.lang.String> VALUE
          Property value.
 
Constructor Summary
ExtendedProperty()
          Constructs an instance using the default key.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getName()
          Returns the name of the property expressed as a URI.
 java.lang.String getRealm()
          Returns the limit on who may see and modify this extended property.
 java.lang.String getValue()
          Returns the property value.
 int hashCode()
           
 boolean hasName()
          Returns whether it has the name of the property expressed as a URI.
 boolean hasRealm()
          Returns whether it has the limit on who may see and modify this extended property.
 boolean hasValue()
          Returns whether it has the property value.
 ExtendedProperty lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 ExtendedProperty setName(java.lang.String name)
          Sets the name of the property expressed as a URI.
 ExtendedProperty setRealm(java.lang.String realm)
          Sets the limit on who may see and modify this extended property.
 ExtendedProperty setValue(java.lang.String value)
          Sets the property value.
 
Methods inherited from class com.google.gdata.model.Element
addElement, addElement, addElement, clear, createElement, createElement, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hasTextValue, isLocked, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, visit
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY

public static final ElementKey<java.lang.Void,ExtendedProperty> KEY
The key for this element.


NAME

public static final AttributeKey<java.lang.String> NAME
Name of the property expressed as a URI.


REALM

public static final AttributeKey<java.lang.String> REALM
Limit on who may see and modify this extended property.


VALUE

public static final AttributeKey<java.lang.String> VALUE
Property value.

Constructor Detail

ExtendedProperty

public ExtendedProperty()
Constructs an instance using the default key.

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.


lock

public ExtendedProperty lock()
Description copied from class: Element
Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:
lock in class Element

getName

public java.lang.String getName()
Returns the name of the property expressed as a URI.

Returns:
name of the property expressed as a URI

setName

public ExtendedProperty setName(java.lang.String name)
Sets the name of the property expressed as a URI.

Parameters:
name - name of the property expressed as a URI or null to reset
Returns:
this to enable chaining setters

hasName

public boolean hasName()
Returns whether it has the name of the property expressed as a URI.

Returns:
whether it has the name of the property expressed as a URI

getRealm

public java.lang.String getRealm()
Returns the limit on who may see and modify this extended property.

Returns:
limit on who may see and modify this extended property

setRealm

public ExtendedProperty setRealm(java.lang.String realm)
Sets the limit on who may see and modify this extended property.

Parameters:
realm - limit on who may see and modify this extended property or null to reset
Returns:
this to enable chaining setters

hasRealm

public boolean hasRealm()
Returns whether it has the limit on who may see and modify this extended property.

Returns:
whether it has the limit on who may see and modify this extended property

getValue

public java.lang.String getValue()
Returns the property value.

Returns:
property value

setValue

public ExtendedProperty setValue(java.lang.String value)
Sets the property value.

Parameters:
value - property value or null to reset
Returns:
this to enable chaining setters

hasValue

public boolean hasValue()
Returns whether it has the property value.

Returns:
whether it has the property value

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class Element

hashCode

public int hashCode()
Overrides:
hashCode in class Element