com.google.gdata.model.gd
Class Ordering

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

public class Ordering
extends Element

Control ordering for a set of atom entries.


Nested Class Summary
static class Ordering.Rel
          Order type.
 
Field Summary
static ElementKey<java.lang.Void,Ordering> KEY
          The key for this element.
static AttributeKey<java.lang.String> NEXT
          Next element.
static AttributeKey<java.lang.String> ORDER_ID
          Ordered feed id.
static AttributeKey<java.lang.String> PREV
          Previous element.
static AttributeKey<java.lang.String> REF
          Other entry id.
static AttributeKey<java.lang.String> REL
          Order type.
 
Constructor Summary
Ordering()
          Constructs an instance using the default key.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getNext()
          Returns the next element.
 java.lang.String getOrderId()
          Returns the ordered feed id.
 java.lang.String getPrev()
          Returns the previous element.
 java.lang.String getRef()
          Returns the other entry id.
 java.lang.String getRel()
          Returns the order type.
 int hashCode()
           
 boolean hasNext()
          Returns whether it has the next element.
 boolean hasOrderId()
          Returns whether it has the ordered feed id.
 boolean hasPrev()
          Returns whether it has the previous element.
 boolean hasRef()
          Returns whether it has the other entry id.
 boolean hasRel()
          Returns whether it has the order type.
 Ordering lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 Ordering setNext(java.lang.String next)
          Sets the next element.
 Ordering setOrderId(java.lang.String orderId)
          Sets the ordered feed id.
 Ordering setPrev(java.lang.String prev)
          Sets the previous element.
 Ordering setRef(java.lang.String ref)
          Sets the other entry id.
 Ordering setRel(java.lang.String rel)
          Sets the order type.
 
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,Ordering> KEY
The key for this element.


ORDER_ID

public static final AttributeKey<java.lang.String> ORDER_ID
Ordered feed id.


REL

public static final AttributeKey<java.lang.String> REL
Order type.


REF

public static final AttributeKey<java.lang.String> REF
Other entry id.


PREV

public static final AttributeKey<java.lang.String> PREV
Previous element.


NEXT

public static final AttributeKey<java.lang.String> NEXT
Next element.

Constructor Detail

Ordering

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

Method Detail

registerMetadata

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


lock

public Ordering 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

getNext

public java.lang.String getNext()
Returns the next element.

Returns:
next element

setNext

public Ordering setNext(java.lang.String next)
Sets the next element.

Parameters:
next - next element or null to reset
Returns:
this to enable chaining setters

hasNext

public boolean hasNext()
Returns whether it has the next element.

Returns:
whether it has the next element

getOrderId

public java.lang.String getOrderId()
Returns the ordered feed id.

Returns:
ordered feed id

setOrderId

public Ordering setOrderId(java.lang.String orderId)
Sets the ordered feed id.

Parameters:
orderId - ordered feed id or null to reset
Returns:
this to enable chaining setters

hasOrderId

public boolean hasOrderId()
Returns whether it has the ordered feed id.

Returns:
whether it has the ordered feed id

getPrev

public java.lang.String getPrev()
Returns the previous element.

Returns:
previous element

setPrev

public Ordering setPrev(java.lang.String prev)
Sets the previous element.

Parameters:
prev - previous element or null to reset
Returns:
this to enable chaining setters

hasPrev

public boolean hasPrev()
Returns whether it has the previous element.

Returns:
whether it has the previous element

getRef

public java.lang.String getRef()
Returns the other entry id.

Returns:
other entry id

setRef

public Ordering setRef(java.lang.String ref)
Sets the other entry id.

Parameters:
ref - other entry id or null to reset
Returns:
this to enable chaining setters

hasRef

public boolean hasRef()
Returns whether it has the other entry id.

Returns:
whether it has the other entry id

getRel

public java.lang.String getRel()
Returns the order type.

Returns:
order type

setRel

public Ordering setRel(java.lang.String rel)
Sets the order type.

Parameters:
rel - order type or null to reset
Returns:
this to enable chaining setters

hasRel

public boolean hasRel()
Returns whether it has the order type.

Returns:
whether it has the order type

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class Element