com.google.gdata.data

Class Link

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.Link

All Implemented Interfaces:

Extension, ILink, Reference

Direct Known Subclasses:

AnalyticsLink, EntryLink, FeedLink, IssuesLink, SitesLink

public class Link
extends ExtensionPoint
implements ILink

External link type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Link.AtomHandler <atom:link> parser.

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

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

ILink.Rel, ILink.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Content	content Nested atom:content element or null if no inlined link content.
protected String	etag Etag of linked resource, or null if unknown
protected String	href Link URI.
protected String	hrefLang Language of resource pointed to by href.
protected long	length Length of the resource pointed to by href, in bytes.
protected String	rel Link relation type.
protected String	title Link title.
protected String	titleLang Language of link title.
protected String	type MIME type of the link target.

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
Link()
Link(String rel, String type, String href)

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(XmlWriter w, ExtensionProfile p) Generates an XML representation for the extension.
void	generateAtom(XmlWriter w, ExtensionProfile extProfile) Generates XML in the Atom format.
void	generateRss(XmlWriter w) Generates XML in the RSS format.
Content	getContent()
String	getEtag()
XmlParser.ElementHandler	getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
String	getHref() Returns the value of the resource reference.
String	getHrefLang()
long	getLength()
String	getRel() Returns the link relation type.
String	getTitle()
String	getTitleLang()
String	getType() Returns the mime type of the link.
boolean	matches(String relToMatch, String typeToMatch) Returns whether this link matches the given rel and type values.
void	setContent(Content c)
void	setEtag(String v)
void	setHref(String v) Sets the value of the resource reference.
void	setHrefLang(String v)
void	setLength(long v)
void	setRel(String v) Sets the link relation type.
void	setTitle(String v)
void	setTitleLang(String v)
void	setType(String v) Sets the mime type of the link.

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rel

protected String rel

Link relation type. Possible values include self, prev, next, enclosure, etc.

type

protected String type

MIME type of the link target.

href

protected String href

Link URI.

hrefLang

protected String hrefLang

Language of resource pointed to by href.

title

protected String title

Link title.

titleLang

protected String titleLang

Language of link title.

length

protected long length

Length of the resource pointed to by href, in bytes.

content

protected Content content

Nested atom:content element or null if no inlined link content.

etag

protected String etag

Etag of linked resource, or null if unknown

Constructor Detail

Link

public Link()

Link

public Link(String rel,
    String type,
    String href)

Method Detail

getRel

public String getRel()

Description copied from interface: ILink

Returns the link relation type. Common values are defined in the ILink.Rel class.

Specified by:

getRel in interface ILink

See Also:

ILink.Rel

setRel

public void setRel(String v)

Description copied from interface: ILink

Sets the link relation type.

Specified by:

setRel in interface ILink

getType

public String getType()

Description copied from interface: ILink

Returns the mime type of the link.

Specified by:

getType in interface ILink

setType

public void setType(String v)

Description copied from interface: ILink

Sets the mime type of the link.

Specified by:

setType in interface ILink

getHref

public String getHref()

Description copied from interface: Reference

Returns the value of the resource reference.

Specified by:

getHref in interface Reference

setHref

public void setHref(String v)

Description copied from interface: Reference

Sets the value of the resource reference.

Specified by:

setHref in interface Reference

Parameters:

v - the resource href.

getHrefLang

public String getHrefLang()

setHrefLang

public void setHrefLang(String v)

getTitle

public String getTitle()

setTitle

public void setTitle(String v)

getTitleLang

public String getTitleLang()

setTitleLang

public void setTitleLang(String v)

getLength

public long getLength()

setLength

public void setLength(long v)

getContent

public Content getContent()

setContent

public void setContent(Content c)

getEtag

public String getEtag()

setEtag

public void setEtag(String v)

matches

public boolean matches(String relToMatch,
              String typeToMatch)

Returns whether this link matches the given rel and type values.

Parameters:

relToMatch - rel value to match or null to match any rel value.

typeToMatch - type value to match or null to match any type value.

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile p,
                                  String namespace,
                                  String localName,
                                  Attributes attrs)

Description copied from class: AbstractExtension

The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.

Specified by:

getHandler in interface Extension

Overrides:

getHandler in class ExtensionPoint

Parameters:

p - extension profile

namespace - extension namespace

localName - tag name, without the namespace prefix

attrs - tag attributes

Returns:

an element handler

generate

public void generate(XmlWriter w,
            ExtensionProfile p)
              throws IOException

Description copied from interface: Extension

Generates an XML representation for the extension.

Specified by:

generate in interface Extension

Overrides:

generate in class AbstractExtension

Parameters:

w - XML writer

p - extension profile

Throws:

IOException

generateAtom

public void generateAtom(XmlWriter w,
                ExtensionProfile extProfile)
                  throws IOException

Generates XML in the Atom format.

Parameters:

w - Output writer.

extProfile - Extension profile.

Throws:

IOException

generateRss

public void generateRss(XmlWriter w)
                 throws IOException

Generates XML in the RSS format.

Parameters:

w - Output writer.

Throws:

IOException