public class

Ordering

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

Class Overview

Control ordering for a set of atom entries.

Summary

Nested Classes
class Ordering.Rel Order type. 
Fields
public static final ElementKey<Void, Ordering> KEY The key for this element.
public static final AttributeKey<String> NEXT Next element.
public static final AttributeKey<String> ORDER_ID Ordered feed id.
public static final AttributeKey<String> PREV Previous element.
public static final AttributeKey<String> REF Other entry id.
public static final AttributeKey<String> REL Order type.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
Ordering()
Constructs an instance using the default key.
Protected Constructors
Ordering(ElementKey<?, ? extends Ordering> key)
Subclass constructor, allows subclasses to supply their own element key.
Ordering(ElementKey<?, ? extends Ordering> 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 getNext()
Returns the next element.
String getOrderId()
Returns the ordered feed id.
String getPrev()
Returns the previous element.
String getRef()
Returns the other entry id.
String getRel()
Returns the order type.
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.
int hashCode()
Ordering lock()
Locks this element.
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
Ordering setNext(String next)
Sets the next element.
Ordering setOrderId(String orderId)
Sets the ordered feed id.
Ordering setPrev(String prev)
Sets the previous element.
Ordering setRef(String ref)
Sets the other entry id.
Ordering setRel(String rel)
Sets the order type.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final ElementKey<Void, Ordering> KEY

The key for this element.

public static final AttributeKey<String> NEXT

Next element.

public static final AttributeKey<String> ORDER_ID

Ordered feed id.

public static final AttributeKey<String> PREV

Previous element.

public static final AttributeKey<String> REF

Other entry id.

public static final AttributeKey<String> REL

Order type.

Public Constructors

public Ordering ()

Constructs an instance using the default key.

Protected Constructors

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

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

Parameters
key

protected Ordering (ElementKey<?, ? extends Ordering> 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 getNext ()

Returns the next element.

Returns
  • next element

public String getOrderId ()

Returns the ordered feed id.

Returns
  • ordered feed id

public String getPrev ()

Returns the previous element.

Returns
  • previous element

public String getRef ()

Returns the other entry id.

Returns
  • other entry id

public String getRel ()

Returns the order type.

Returns
  • order type

public boolean hasNext ()

Returns whether it has the next element.

Returns
  • whether it has the next element

public boolean hasOrderId ()

Returns whether it has the ordered feed id.

Returns
  • whether it has the ordered feed id

public boolean hasPrev ()

Returns whether it has the previous element.

Returns
  • whether it has the previous element

public boolean hasRef ()

Returns whether it has the other entry id.

Returns
  • whether it has the other entry id

public boolean hasRel ()

Returns whether it has the order type.

Returns
  • whether it has the order type

public int hashCode ()

public Ordering 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 Ordering setNext (String next)

Sets the next element.

Parameters
next Next element or null to reset
Returns
  • this to enable chaining setters

public Ordering setOrderId (String orderId)

Sets the ordered feed id.

Parameters
orderId Ordered feed id or null to reset
Returns
  • this to enable chaining setters

public Ordering setPrev (String prev)

Sets the previous element.

Parameters
prev Previous element or null to reset
Returns
  • this to enable chaining setters

public Ordering setRef (String ref)

Sets the other entry id.

Parameters
ref Other entry id or null to reset
Returns
  • this to enable chaining setters

public Ordering setRel (String rel)

Sets the order type.

Parameters
rel Order type or null to reset
Returns
  • this to enable chaining setters