public class

ExtendedProperty

extends Element
java.lang.Object
   ↳ com.google.gdata.model.Element
     ↳ com.google.gdata.model.gd.ExtendedProperty

Class Overview

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

Summary

Nested Classes
class ExtendedProperty.Realm Limit on who may see and modify this extended property. 
Fields
public static final ElementKey<Void, ExtendedProperty> KEY The key for this element.
public static final AttributeKey<String> NAME Name of the property expressed as a URI.
public static final AttributeKey<String> REALM Limit on who may see and modify this extended property.
public static final AttributeKey<String> VALUE Property value.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
ExtendedProperty()
Constructs an instance using the default key.
Protected Constructors
ExtendedProperty(ElementKey<?, ? extends ExtendedProperty> key)
Subclass constructor, allows subclasses to supply their own element key.
ExtendedProperty(ElementKey<?, ? extends ExtendedProperty> key, Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance.
Public Methods
boolean equals(Object obj)
String getName()
Returns the name of the property expressed as a URI.
String getRealm()
Returns the limit on who may see and modify this extended property.
String getValue()
Returns the property value.
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.
int hashCode()
ExtendedProperty lock()
Locks this element.
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
ExtendedProperty setName(String name)
Sets the name of the property expressed as a URI.
ExtendedProperty setRealm(String realm)
Sets the limit on who may see and modify this extended property.
ExtendedProperty setValue(String value)
Sets the property value.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final ElementKey<Void, ExtendedProperty> KEY

The key for this element.

public static final AttributeKey<String> NAME

Name of the property expressed as a URI.

public static final AttributeKey<String> REALM

Limit on who may see and modify this extended property.

public static final AttributeKey<String> VALUE

Property value.

Public Constructors

public ExtendedProperty ()

Constructs an instance using the default key.

Protected Constructors

protected ExtendedProperty (ElementKey<?, ? extends ExtendedProperty> key)

Subclass constructor, allows subclasses to supply their own element key.

Parameters
key

protected ExtendedProperty (ElementKey<?, ? extends ExtendedProperty> key, Element source)

Constructs a new instance by doing a shallow copy of data from an existing Element instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use createElement(ElementKey, Element).

Parameters
key The key to use for this element.
source Source element

Public Methods

public boolean equals (Object obj)

Parameters
obj

public String getName ()

Returns the name of the property expressed as a URI.

Returns
  • name of the property expressed as a URI

public 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

public String getValue ()

Returns the property value.

Returns
  • property value

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

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

public boolean hasValue ()

Returns whether it has the property value.

Returns
  • whether it has the property value

public int hashCode ()

public ExtendedProperty lock ()

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.

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters
registry

public ExtendedProperty setName (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

public ExtendedProperty setRealm (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

public ExtendedProperty setValue (String value)

Sets the property value.

Parameters
value Property value or null to reset
Returns
  • this to enable chaining setters