com.google.gdata.data.sites

Class SitesLink

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.Link

com.google.gdata.data.sites.SitesLink

All Implemented Interfaces:

Extension, ILink, Reference

public class SitesLink
extends Link

Describes a sites link.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SitesLink.Rel Link relation type.
static class	SitesLink.Type MIME type of link target.

Nested classes/interfaces inherited from class com.google.gdata.data.Link

Link.AtomHandler

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields inherited from class com.google.gdata.data.Link

content, etag, href, hrefLang, length, rel, title, titleLang, type

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
SitesLink() Default mutable constructor.
SitesLink(Integer count, String href, String hrefLang, Long length, String rel, String title, String titleLang, String type, DateTime updated) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
boolean	equals(Object obj)
Integer	getCount() Returns the provides a hint to clients as to the total number of replies contained by the linked resource.
static ExtensionDescription	getDefaultDescription(boolean required, boolean repeatable) Returns the extension description, specifying whether it is required, and whether it is repeatable.
DateTime	getUpdated() Returns the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.
boolean	hasCount() Returns whether it has the provides a hint to clients as to the total number of replies contained by the linked resource.
int	hashCode()
boolean	hasUpdated() Returns whether it has the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setCount(Integer count) Sets the provides a hint to clients as to the total number of replies contained by the linked resource.
void	setUpdated(DateTime updated) Sets the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.
String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

Methods inherited from class com.google.gdata.data.Link

generate, generateAtom, generateRss, getContent, getEtag, getHandler, getHref, getHrefLang, getLength, getRel, getTitle, getTitleLang, getType, matches, setContent, setEtag, setHref, setHrefLang, setLength, setRel, setTitle, setTitleLang, setType

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable

Methods inherited from class java.lang.Object

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

Constructor Detail

SitesLink

public SitesLink()

Default mutable constructor.

SitesLink

public SitesLink(Integer count,
         String href,
         String hrefLang,
         Long length,
         String rel,
         String title,
         String titleLang,
         String type,
         DateTime updated)

Immutable constructor.

Parameters:

count - provides a hint to clients as to the total number of replies contained by the linked resource.

updated - provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.

Method Detail

getCount

public Integer getCount()

Returns the provides a hint to clients as to the total number of replies contained by the linked resource.

Returns:

provides a hint to clients as to the total number of replies contained by the linked resource

setCount

public void setCount(Integer count)

Sets the provides a hint to clients as to the total number of replies contained by the linked resource.

Parameters:

count - provides a hint to clients as to the total number of replies contained by the linked resource or null to reset

hasCount

public boolean hasCount()

Returns whether it has the provides a hint to clients as to the total number of replies contained by the linked resource.

Returns:

whether it has the provides a hint to clients as to the total number of replies contained by the linked resource

getUpdated

public DateTime getUpdated()

Returns the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.

Returns:

provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource

setUpdated

public void setUpdated(DateTime updated)

Sets the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.

Parameters:

updated - provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource or null to reset

hasUpdated

public boolean hasUpdated()

Returns whether it has the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource.

Returns:

whether it has the provides a hint to clients as to the date and time of the most recently updated reply contained by the linked resource

validate

protected void validate()

Description copied from class: AbstractExtension

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.

Overrides:

validate in class AbstractExtension

getDefaultDescription

public static ExtensionDescription getDefaultDescription(boolean required,
                                         boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters:

required - whether it is required

repeatable - whether it is repeatable

Returns:

extension description

putAttributes

protected void putAttributes(AttributeGenerator generator)

Description copied from class: AbstractExtension

Puts attributes into the attribute generator. Called from AbstractExtension.generate(XmlWriter,ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

putAttributes in class AbstractExtension

Parameters:

generator - attribute generator

consumeAttributes

protected void consumeAttributes(AttributeHelper helper)
                          throws ParseException

Description copied from class: AbstractExtension

Consumes attributes from the attribute helper. May also use AttributeHelper.consumeContent(boolean) to consume the element's text content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

consumeAttributes in class AbstractExtension

Parameters:

helper - attribute helper

Throws:

ParseException - any parsing exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object