com.google.gdata.model.gd
Class FeedLink

java.lang.Object
  com.google.gdata.model.Element
      com.google.gdata.model.gd.FeedLink

All Implemented Interfaces:

ILink, Reference

public class FeedLink
extends Element
implements ILink

Describes a nested feed link.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gdata.data.ILink

ILink.Rel, ILink.Type

Field Summary

static AttributeKey<java.lang.Integer>	COUNT_HINT Qualified name of hint at the number of entries in the feed attribute.
static AttributeKey<java.lang.String>	HREF Qualified name of feed URI attribute.
static ElementKey<java.lang.Void,FeedLink>	KEY The key for this element.
static AttributeKey<java.lang.Boolean>	READ_ONLY Qualified name of whether the contained feed is read-only attribute.
static AttributeKey<java.lang.String>	REL Qualified name of feed relation type attribute.

Constructor Summary

	FeedLink() Default mutable constructor.
protected	FeedLink(ElementKey<?,? extends FeedLink> key) Lets subclasses create an instance using a custom key.
protected	FeedLink(ElementKey<?,? extends FeedLink> key, Element source) Constructs a new instance by doing a shallow copy of data from an existing Element instance.

Method Summary

java.lang.Integer	getCountHint() Returns the hint at the number of entries in the feed.
Feed	getFeed() Returns the nested feed.
java.lang.String	getHref() Returns the feed URI.
java.lang.Boolean	getReadOnly() Returns the whether the contained feed is read-only.
java.lang.String	getRel() Returns the feed relation type.
java.lang.String	getType() Returns the mime type of the link.
boolean	hasCountHint() Returns whether it has the hint at the number of entries in the feed.
boolean	hasFeed() Returns whether it has the nested feed.
boolean	hasHref() Returns whether it has the feed URI.
boolean	hasReadOnly() Returns whether it has the whether the contained feed is read-only.
boolean	hasRel() Returns whether it has the feed relation type.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
void	setCountHint(java.lang.Integer countHint) Sets the hint at the number of entries in the feed.
void	setFeed(Feed feed) Sets the nested feed.
void	setHref(java.lang.String href) Sets the feed URI.
void	setReadOnly(java.lang.Boolean readOnly) Sets the whether the contained feed is read-only.
void	setRel(java.lang.String rel) Sets the feed relation type.
void	setType(java.lang.String type) Sets the mime type of the link.
java.lang.String	toString()

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, lock, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, validate, visit

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final ElementKey<java.lang.Void,FeedLink> KEY

The key for this element.

COUNT_HINT

public static final AttributeKey<java.lang.Integer> COUNT_HINT

Qualified name of hint at the number of entries in the feed attribute.

HREF

public static final AttributeKey<java.lang.String> HREF

Qualified name of feed URI attribute.

READ_ONLY

public static final AttributeKey<java.lang.Boolean> READ_ONLY

Qualified name of whether the contained feed is read-only attribute.

REL

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

Qualified name of feed relation type attribute.

Constructor Detail

FeedLink

public FeedLink()

Default mutable constructor.

FeedLink

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

Lets subclasses create an instance using a custom key.

FeedLink

protected FeedLink(ElementKey<?,? extends FeedLink> 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.

Parameters:

key - element key to use for this element.

source - source element

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)

Registers the metadata for this element.

getCountHint

public java.lang.Integer getCountHint()

Returns the hint at the number of entries in the feed.

Returns:

hint at the number of entries in the feed

setCountHint

public void setCountHint(java.lang.Integer countHint)

Sets the hint at the number of entries in the feed.

Parameters:

countHint - hint at the number of entries in the feed or null to reset

hasCountHint

public boolean hasCountHint()

Returns whether it has the hint at the number of entries in the feed.

Returns:

whether it has the hint at the number of entries in the feed

getFeed

public Feed getFeed()

Returns the nested feed.

Returns:

nested feed

setFeed

public void setFeed(Feed feed)

Sets the nested feed.

Parameters:

feed - nested feed or null to reset

hasFeed

public boolean hasFeed()

Returns whether it has the nested feed.

Returns:

whether it has the nested feed

getHref

public java.lang.String getHref()

Returns the feed URI.

Specified by:

getHref in interface Reference

Returns:

feed URI

setHref

public void setHref(java.lang.String href)

Sets the feed URI.

Specified by:

setHref in interface Reference

Parameters:

href - feed URI or null to reset

hasHref

public boolean hasHref()

Returns whether it has the feed URI.

Returns:

whether it has the feed URI

getReadOnly

public java.lang.Boolean getReadOnly()

Returns the whether the contained feed is read-only.

Returns:

whether the contained feed is read-only

setReadOnly

public void setReadOnly(java.lang.Boolean readOnly)

Sets the whether the contained feed is read-only.

Parameters:

readOnly - whether the contained feed is read-only or null to reset

hasReadOnly

public boolean hasReadOnly()

Returns whether it has the whether the contained feed is read-only.

Returns:

whether it has the whether the contained feed is read-only

getRel

public java.lang.String getRel()

Returns the feed relation type.

Specified by:

getRel in interface ILink

Returns:

feed relation type

See Also:

ILink.Rel

setRel

public void setRel(java.lang.String rel)

Sets the feed relation type.

Specified by:

setRel in interface ILink

Parameters:

rel - feed relation type or null to reset

hasRel

public boolean hasRel()

Returns whether it has the feed relation type.

Returns:

whether it has the feed relation type

toString

public java.lang.String toString()

Overrides:

toString in class Element

getType

public java.lang.String getType()

Description copied from interface: ILink

Returns the mime type of the link.

Specified by:

getType in interface ILink

setType

public void setType(java.lang.String type)

Description copied from interface: ILink

Sets the mime type of the link.

Specified by:

setType in interface ILink