|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.representation.Variant
org.restlet.representation.RepresentationInfo
org.restlet.representation.Representation
org.restlet.representation.CharacterRepresentation
org.restlet.representation.WriterRepresentation
org.restlet.ext.xml.XmlRepresentation
org.restlet.ext.xml.SaxRepresentation
org.restlet.ext.atom.Feed
public class Feed
Atom Feed Document, acting as a component for metadata and data associated with the feed.
Field Summary | |
---|---|
static java.lang.String |
ATOM_NAMESPACE
Atom Syndication Format namespace. |
static java.lang.String |
XHTML_NAMESPACE
XHTML namespace. |
Fields inherited from class org.restlet.representation.Representation |
---|
UNKNOWN_SIZE |
Constructor Summary | |
---|---|
Feed()
Constructor. |
|
Feed(Client clientDispatcher,
java.lang.String feedUri)
Constructor. |
|
Feed(Context context,
java.lang.String feedUri)
Constructor. |
|
Feed(Representation xmlFeed)
Constructor. |
|
Feed(Representation xmlFeed,
FeedReader feedReader)
Constructor. |
|
Feed(java.lang.String feedUri)
Constructor. |
Method Summary | |
---|---|
java.util.List<Person> |
getAuthors()
Returns the authors of the feed. |
Reference |
getBaseReference()
Returns the base reference used to resolve relative references found within the scope of the xml:base attribute. |
java.util.List<Category> |
getCategories()
Returns the categories associated with the feed. |
java.util.List<Person> |
getContributors()
Returns the contributors to the feed. |
java.util.List<Entry> |
getEntries()
Returns the individual entries, acting as a components for associated metadata and data. |
Generator |
getGenerator()
Returns the agent used to generate a feed. |
Reference |
getIcon()
Returns the image that provides iconic visual identification for a feed. |
java.lang.String |
getId()
Returns the permanent, universally unique identifier for the feed. |
java.util.List<Link> |
getLinks()
Returns the references from the entry to Web resources. |
Reference |
getLogo()
Returns the image that provides visual identification for a feed. |
Text |
getRights()
Returns the information about rights held in and over an feed. |
Text |
getSubtitle()
Returns the short summary, abstract, or excerpt of an feed. |
Text |
getTitle()
Returns the human-readable title for the feed. |
java.util.Date |
getUpdated()
Returns the most recent moment when the entry was modified in a significant way. |
void |
setBaseReference(Reference baseReference)
Sets the base reference used to resolve relative references found within the scope of the xml:base attribute. |
void |
setBaseReference(java.lang.String baseUri)
Sets the base URI used to resolve relative references found within the scope of the xml:base attribute. |
void |
setGenerator(Generator generator)
Sets the agent used to generate a feed. |
void |
setIcon(Reference icon)
Sets the image that provides iconic visual identification for a feed. |
void |
setId(java.lang.String id)
Sets the permanent, universally unique identifier for the feed. |
void |
setLogo(Reference logo)
Sets the image that provides visual identification for a feed. |
void |
setRights(java.lang.String rights)
Sets the information about rights held in and over an feed. |
void |
setRights(Text rights)
Sets the information about rights held in and over an feed. |
void |
setSubtitle(java.lang.String subtitle)
Sets the short summary, abstract, or excerpt of an feed. |
void |
setSubtitle(Text subtitle)
Sets the short summary, abstract, or excerpt of an feed. |
void |
setTitle(java.lang.String title)
Sets the human-readable title for the feed. |
void |
setTitle(Text title)
Sets the human-readable title for the feed. |
void |
setUpdated(java.util.Date updated)
Sets the most recent moment when the feed was modified in a significant way. |
void |
write(XmlWriter writer)
Writes the representation to a XML writer. |
void |
writeElement(XmlWriter writer)
Writes the current object as an XML element using the given SAX writer. |
Methods inherited from class org.restlet.ext.xml.SaxRepresentation |
---|
getInputSource, parse, release, write, write |
Methods inherited from class org.restlet.representation.WriterRepresentation |
---|
getReader |
Methods inherited from class org.restlet.representation.CharacterRepresentation |
---|
getChannel, getStream, write |
Methods inherited from class org.restlet.representation.Representation |
---|
append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient |
Methods inherited from class org.restlet.representation.RepresentationInfo |
---|
getModificationDate, getTag, setModificationDate, setTag |
Methods inherited from class org.restlet.representation.Variant |
---|
createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATOM_NAMESPACE
public static final java.lang.String XHTML_NAMESPACE
Constructor Detail |
---|
public Feed()
public Feed(Client clientDispatcher, java.lang.String feedUri) throws java.io.IOException
clientDispatcher
- The client HTTP dispatcher.feedUri
- The feed URI.
java.io.IOException
public Feed(Context context, java.lang.String feedUri) throws java.io.IOException
context
- The context from which the client dispatcher will be
retrieved.feedUri
- The feed URI.
java.io.IOException
public Feed(Representation xmlFeed) throws java.io.IOException
xmlFeed
- The XML feed document.
java.io.IOException
public Feed(Representation xmlFeed, FeedReader feedReader) throws java.io.IOException
xmlFeed
- The XML feed document.feedReader
- Custom feed reader.
java.io.IOException
public Feed(java.lang.String feedUri) throws java.io.IOException
feedUri
- The feed URI.
java.io.IOException
Method Detail |
---|
public java.util.List<Person> getAuthors()
public Reference getBaseReference()
public java.util.List<Category> getCategories()
public java.util.List<Person> getContributors()
public java.util.List<Entry> getEntries()
public Generator getGenerator()
public Reference getIcon()
public java.lang.String getId()
public java.util.List<Link> getLinks()
public Reference getLogo()
public Text getRights()
public Text getSubtitle()
public Text getTitle()
public java.util.Date getUpdated()
public void setBaseReference(Reference baseReference)
baseReference
- The base reference used to resolve relative references found
within the scope of the xml:base attribute.public void setBaseReference(java.lang.String baseUri)
baseUri
- The base URI used to resolve relative references found within
the scope of the xml:base attribute.public void setGenerator(Generator generator)
generator
- The agent used to generate a feed.public void setIcon(Reference icon)
icon
- The image that provides iconic visual identification for a
feed.public void setId(java.lang.String id)
id
- The permanent, universally unique identifier for the feed.public void setLogo(Reference logo)
logo
- The image that provides visual identification for a feed.public void setRights(java.lang.String rights)
rights
- The information about rights held in and over an feed.public void setRights(Text rights)
rights
- The information about rights held in and over an feed.public void setSubtitle(java.lang.String subtitle)
subtitle
- The short summary, abstract, or excerpt of an feed.public void setSubtitle(Text subtitle)
subtitle
- The short summary, abstract, or excerpt of an feed.public void setTitle(java.lang.String title)
title
- The human-readable title for the feed.public void setTitle(Text title)
title
- The human-readable title for the feed.public void setUpdated(java.util.Date updated)
updated
- The most recent moment when the feed was modified in a
significant way.public void write(XmlWriter writer) throws java.io.IOException
write
in class SaxRepresentation
writer
- The XML writer to write to.
java.io.IOException
public void writeElement(XmlWriter writer) throws org.xml.sax.SAXException
writer
- The SAX writer.
org.xml.sax.SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |