public class

Where

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

Class Overview

Describes a place (not necessarily a specific geographical location).

Summary

Nested Classes
class Where.Rel Meaning of this location. 
Fields
public static final ElementKey<Void, Where> KEY The key for this element.
public static final AttributeKey<String> LABEL User-readable label that identifies this location in case multiple locations may be present.
public static final AttributeKey<String> REL Meaning of this location.
public static final AttributeKey<String> VALUE_STRING Text description of the place.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
Where()
Constructs an instance using the default key.
Protected Constructors
Where(ElementKey<?, ? extends Where> key)
Subclass constructor, allows subclasses to supply their own element key.
Where(ElementKey<?, ? extends Where> key, Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance.
Public Methods
EntryLink getEntryLink()
Returns the nested person or venue (Contact) entry.
String getLabel()
Returns the user-readable label that identifies this location in case multiple locations may be present.
String getRel()
Returns the meaning of this location.
String getValueString()
Returns the text description of the place.
boolean hasEntryLink()
Returns whether it has the nested person or venue (Contact) entry.
boolean hasLabel()
Returns whether it has the user-readable label that identifies this location in case multiple locations may be present.
boolean hasRel()
Returns whether it has the meaning of this location.
boolean hasValueString()
Returns whether it has the text description of the place.
Where lock()
Locks this element.
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
Where setEntryLink(EntryLink entryLink)
Sets the nested person or venue (Contact) entry.
Where setLabel(String label)
Sets the user-readable label that identifies this location in case multiple locations may be present.
Where setRel(String rel)
Sets the meaning of this location.
Where setValueString(String valueString)
Sets the text description of the place.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final ElementKey<Void, Where> KEY

The key for this element.

public static final AttributeKey<String> LABEL

User-readable label that identifies this location in case multiple locations may be present.

public static final AttributeKey<String> REL

Meaning of this location.

public static final AttributeKey<String> VALUE_STRING

Text description of the place.

Public Constructors

public Where ()

Constructs an instance using the default key.

Protected Constructors

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

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

Parameters
key

protected Where (ElementKey<?, ? extends Where> 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 EntryLink getEntryLink ()

Returns the nested person or venue (Contact) entry.

Returns
  • nested person or venue (Contact) entry

public String getLabel ()

Returns the user-readable label that identifies this location in case multiple locations may be present.

Returns
  • user-readable label that identifies this location in case multiple locations may be present

public String getRel ()

Returns the meaning of this location.

Returns
  • meaning of this location

public String getValueString ()

Returns the text description of the place.

Returns
  • text description of the place

public boolean hasEntryLink ()

Returns whether it has the nested person or venue (Contact) entry.

Returns
  • whether it has the nested person or venue (Contact) entry

public boolean hasLabel ()

Returns whether it has the user-readable label that identifies this location in case multiple locations may be present.

Returns
  • whether it has the user-readable label that identifies this location in case multiple locations may be present

public boolean hasRel ()

Returns whether it has the meaning of this location.

Returns
  • whether it has the meaning of this location

public boolean hasValueString ()

Returns whether it has the text description of the place.

Returns
  • whether it has the text description of the place

public Where 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 Where setEntryLink (EntryLink entryLink)

Sets the nested person or venue (Contact) entry.

Parameters
entryLink Nested person or venue (Contact) entry or null to reset
Returns
  • this to enable chaining setters

public Where setLabel (String label)

Sets the user-readable label that identifies this location in case multiple locations may be present.

Parameters
label User-readable label that identifies this location in case multiple locations may be present or null to reset
Returns
  • this to enable chaining setters

public Where setRel (String rel)

Sets the meaning of this location.

Parameters
rel Meaning of this location or null to reset
Returns
  • this to enable chaining setters

public Where setValueString (String valueString)

Sets the text description of the place.

Parameters
valueString Text description of the place or null to reset
Returns
  • this to enable chaining setters