com.google.gdata.model.atompub

Class Categories

java.lang.Object

com.google.gdata.model.Element

com.google.gdata.model.atompub.Categories

public class Categories
extends Element

Value of the app:categories tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Categories.Fixed Indicates whether the list of categories is a fixed or an open set.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeKey<Categories.Fixed>	FIXED Indicates whether the list of categories is a fixed or an open set.
static AttributeKey<String>	HREF An IRI reference to a Category Document.
static ElementKey<Void,Categories>	KEY The key for this element.
static AttributeKey<String>	SCHEME Default scheme of the contained category elements.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Categories() Constructs an instance using the default key.
protected	Categories(ElementKey<?,? extends Categories> key) Subclass constructor, allows subclasses to supply their own element key.
protected	Categories(ElementKey<?,? extends Categories> key, Element source) Constructs a new instance by doing a shallow copy of data from an existing Element instance.

Method Summary

Methods

Modifier and Type	Method and Description
Categories	addCategory(Category category) Adds a new category.
void	clearCategories() Removes all existing category instances.
List<Category>	getCategories() Returns the categories.
Categories.Fixed	getFixed() Returns the indicates whether the list of categories is a fixed or an open set.
String	getHref() Returns the an IRI reference to a Category Document.
String	getScheme() Returns the default scheme of the contained category elements.
boolean	hasCategories() Returns whether it has the categories.
boolean	hasFixed() Returns whether it has the indicates whether the list of categories is a fixed or an open set.
boolean	hasHref() Returns whether it has the an IRI reference to a Category Document.
boolean	hasScheme() Returns whether it has the default scheme of the contained category elements.
Categories	lock() Locks this element.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
boolean	removeCategory(Category category) Removes an existing category.
Categories	setFixed(Categories.Fixed fixed) Sets the indicates whether the list of categories is a fixed or an open set.
Categories	setHref(String href) Sets the an IRI reference to a Category Document.
Categories	setScheme(String scheme) Sets the default scheme of the contained category elements.

Methods inherited from class com.google.gdata.model.Element

adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, equals, 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, hashCode, hasTextValue, isLocked, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY

public static final ElementKey<Void,Categories> KEY

The key for this element.

FIXED

public static final AttributeKey<Categories.Fixed> FIXED

Indicates whether the list of categories is a fixed or an open set.

HREF

public static final AttributeKey<String> HREF

An IRI reference to a Category Document.

SCHEME

public static final AttributeKey<String> SCHEME

Default scheme of the contained category elements.

Constructor Detail

Categories

public Categories()

Constructs an instance using the default key.

Categories

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

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

Categories

protected Categories(ElementKey<?,? extends Categories> 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 Element.createElement(ElementKey, Element).

Parameters:

key - The key to use for this element.

source - source element

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)

Registers the metadata for this element.

lock

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

getCategories

public List<Category> getCategories()

Returns the categories.

Returns:

categories

addCategory

public Categories addCategory(Category category)

Adds a new category.

Parameters:

category - category

removeCategory

public boolean removeCategory(Category category)

Removes an existing category.

Parameters:

category - category

Returns:

true if the category was removed

clearCategories

public void clearCategories()

Removes all existing category instances.

hasCategories

public boolean hasCategories()

Returns whether it has the categories.

Returns:

whether it has the categories

getFixed

public Categories.Fixed getFixed()

Returns the indicates whether the list of categories is a fixed or an open set.

Returns:

indicates whether the list of categories is a fixed or an open set

setFixed

public Categories setFixed(Categories.Fixed fixed)

Sets the indicates whether the list of categories is a fixed or an open set.

Parameters:

fixed - indicates whether the list of categories is a fixed or an open set or null to reset

Returns:

this to enable chaining setters

hasFixed

public boolean hasFixed()

Returns whether it has the indicates whether the list of categories is a fixed or an open set.

Returns:

whether it has the indicates whether the list of categories is a fixed or an open set

getHref

public String getHref()

Returns the an IRI reference to a Category Document.

Returns:

an IRI reference to a Category Document

setHref

public Categories setHref(String href)

Sets the an IRI reference to a Category Document.

Parameters:

href - an IRI reference to a Category Document or null to reset

Returns:

this to enable chaining setters

hasHref

public boolean hasHref()

Returns whether it has the an IRI reference to a Category Document.

Returns:

whether it has the an IRI reference to a Category Document

getScheme

public String getScheme()

Returns the default scheme of the contained category elements.

Returns:

default scheme of the contained category elements

setScheme

public Categories setScheme(String scheme)

Sets the default scheme of the contained category elements.

Parameters:

scheme - default scheme of the contained category elements or null to reset

Returns:

this to enable chaining setters

hasScheme

public boolean hasScheme()

Returns whether it has the default scheme of the contained category elements.

Returns:

whether it has the default scheme of the contained category elements