com.google.gdata.model.gd
Class MessageFeed

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.atom.Source
          extended by com.google.gdata.model.atom.Feed
              extended by com.google.gdata.model.gd.MessageFeed
All Implemented Interfaces:
IAtom, IFeed

public class MessageFeed
extends Feed

Describes a message feed.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gdata.model.atom.Feed
Feed.FeedState
 
Nested classes/interfaces inherited from class com.google.gdata.model.atom.Source
Source.Generator
 
Field Summary
static Category CATEGORY
          Message kind category.
static ElementKey<java.lang.Void,MessageFeed> KEY
          The key for this element.
static java.lang.String KIND
          Message kind term value.
 
Fields inherited from class com.google.gdata.model.atom.Feed
feedState, ITEMS_PER_PAGE, START_INDEX, TOTAL_RESULTS, XML_BASE
 
Fields inherited from class com.google.gdata.model.atom.Source
CONSTRUCT, ICON, ID, LOGO, RIGHTS, SUBTITLE, TITLE, UPDATED
 
Constructor Summary
  MessageFeed()
          Constructs an instance using the default key.
protected MessageFeed(ElementKey<?,? extends MessageFeed> key)
          Subclass constructor, allows subclasses to supply their own element key.
protected MessageFeed(ElementKey<?,? extends MessageFeed> key, Feed source)
          Constructs a new instance by doing a shallow copy of data from an existing Feed instance.
  MessageFeed(Feed sourceFeed)
          Constructs a new instance by doing a shallow copy of data from an existing Feed instance.
 
Method Summary
 java.util.List<? extends MessageEntry> getEntries()
          Returns the list of entries in this feed
 MessageFeed lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 
Methods inherited from class com.google.gdata.model.atom.Feed
addEntry, clearEntries, createEntry, createEntry, getCanPost, getEntries, getEntries, getEntryPostLink, getEtag, getFeedBatchLink, getItemsPerPage, getKind, getNextLink, getPreviousLink, getSelectedFields, getSelf, getSelfLink, getService, getStartIndex, getTotalResults, getVersionId, getXmlBase, insert, narrow, removeEntry, removeLinks, resolve, setCanPost, setEntries, setEtag, setItemsPerPage, setKind, setSelectedFields, setService, setStartIndex, setTotalResults, setVersionId, setXmlBase
 
Methods inherited from class com.google.gdata.model.atom.Source
addAuthor, addAuthors, addCategory, addContributor, addContributors, addHtmlLink, addLink, addLink, clearAuthors, clearCategories, clearContributors, clearLinks, getAuthors, getCategories, getContributors, getGenerator, getHtmlLink, getIcon, getIconUri, getId, getLink, getLinks, getLinks, getLogo, getLogoUri, getRights, getSubtitle, getTitle, getUpdated, removeAuthor, removeContributor, removeLink, removeLinks, setGenerator, setGenerator, setIcon, setIcon, setId, setLogo, setLogo, setRights, setSubtitle, setTitle, setUpdated
 
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, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, 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
 
Methods inherited from interface com.google.gdata.data.IFeed
getGenerator, getLogo, getSubtitle, setGenerator, setLogo
 
Methods inherited from interface com.google.gdata.data.IAtom
addLink, getAuthors, getCategories, getId, getLink, getLinks, getTitle, getUpdated, removeLinks, setId, setUpdated
 

Field Detail

KIND

public static final java.lang.String KIND
Message kind term value.

See Also:
Constant Field Values

CATEGORY

public static final Category CATEGORY
Message kind category.


KEY

public static final ElementKey<java.lang.Void,MessageFeed> KEY
The key for this element.

Constructor Detail

MessageFeed

public MessageFeed()
Constructs an instance using the default key.


MessageFeed

public MessageFeed(Feed sourceFeed)
Constructs a new instance by doing a shallow copy of data from an existing Feed instance.

Parameters:
sourceFeed - source feed

MessageFeed

protected MessageFeed(ElementKey<?,? extends MessageFeed> key)
Subclass constructor, allows subclasses to supply their own element key.


MessageFeed

protected MessageFeed(ElementKey<?,? extends MessageFeed> key,
                      Feed source)
Constructs a new instance by doing a shallow copy of data from an existing Feed 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 MessageFeed 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

getEntries

public java.util.List<? extends MessageEntry> getEntries()
Description copied from class: Feed
Returns the list of entries in this feed

Specified by:
getEntries in interface IFeed
Overrides:
getEntries in class Feed