public class

MessageFeed

extends Feed

java.lang.Object
↳	com.google.gdata.model.Element
	↳	com.google.gdata.model.atom.Source
		↳	com.google.gdata.model.atom.Feed
			↳	com.google.gdata.model.gd.MessageFeed

Class Overview

Describes a message feed.

Summary

Constants
String	KIND	Message kind term value.

Fields
public static final Category	CATEGORY	Message kind category.
public static final ElementKey<Void, MessageFeed>	KEY	The key for this element.

[Expand]

Inherited Fields

From class com.google.gdata.model.atom.Feed

From class com.google.gdata.model.atom.Source

From class com.google.gdata.model.Element

Public Constructors
	MessageFeed() Constructs an instance using the default key.
	MessageFeed(Feed sourceFeed) Constructs a new instance by doing a shallow copy of data from an existing `Feed` instance.

Protected Constructors
	MessageFeed(ElementKey<?, ? extends MessageFeed> key) Subclass constructor, allows subclasses to supply their own element key.
	MessageFeed(ElementKey<?, ? extends MessageFeed> key, Feed source) Constructs a new instance by doing a shallow copy of data from an existing `Feed` instance.

Public Methods
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.

[Expand]

Inherited Methods

From class com.google.gdata.model.atom.Feed

void	addEntry(Entry entry) Adds an entry to this feed.
void	clearEntries() Clears the list of entries on this feed.
Entry	createEntry() Creates a new entry for the feed.
<E extends Entry> E	createEntry(ElementKey<?, E> entryKey) Creates a new entry for the feed.
boolean	getCanPost() Gets the property that indicates if it is possible to post new entries to the feed.
<T extends Entry> List<T>	getEntries(Class<T> returnClass) Gets a list of entries of a particular kind.
List<? extends Entry>	getEntries() Returns the list of entries in this feed
<T extends Entry> List<T>	getEntries(ElementKey<?, T> key) Returns a list of entries matching the given entry key.
Link	getEntryPostLink() Returns the entry post link for the feed.
String	getEtag() Returns the `ETAG` value for this feed.
Link	getFeedBatchLink() Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.
int	getItemsPerPage() Gets the number of items that will be returned per page for paged feeds.
String	getKind() Returns the `KIND` value for this feed.
Link	getNextLink() Returns the link that provides the URI of next page in a paged feed.
Link	getPreviousLink() Returns the link that provides the URI of previous page in a paged feed.
String	getSelectedFields() Returns the `FIELDS` value for this feed.
Feed	getSelf() Returns the current representation of the feed by requesting it from the associated service using the feed's self link.
Link	getSelfLink() Returns the self link for the feed.
Service	getService() Returns that GData `Service` instance tassociated with this feed.
int	getStartIndex() Gets the starting index of the contained entries for paged feeds.
int	getTotalResults() Gets the total number of results associated with this feed.
String	getVersionId() Returns the resource version id for this feed.
URI	getXmlBase() Returns the current xml:base attribute for this feed.
<T extends Entry> T	insert(T newEntry) Inserts a new Entry into the feed, if the feed is currently associated with a Service.
Element	narrow(ElementMetadata<?, ?> meta, ValidationContext vc) Narrows this feed using categories with an appropriate kind value.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
boolean	removeEntry(Entry entry) Removes a single entry from this feed.
void	removeLinks() Removes all links.
Element	resolve(ElementMetadata<?, ?> metadata, ValidationContext vc) Resolve this element's state against the metadata.
void	setCanPost(boolean v) Sets the property that indicates if it is possible to post new entries to the feed.
void	setEntries(Collection<? extends Entry> entries) Sets the entries in this feed to the given entries.
void	setEtag(String v) Sets the `ETAG` value for this feed.
void	setItemsPerPage(int v) Sets the number of items that will be returned per page for paged feeds.
void	setKind(String v) Sets the `KIND` value for this feed.
void	setSelectedFields(String v) Sets the`FIELDS` value for this feed.
void	setService(Service v) Sets that GData `Service` instance associated with this feed.
void	setStartIndex(int v) Sets the starting index of the contained entries for paged feeds.
void	setTotalResults(int v) Sets the total number of results associated with this feed.
void	setVersionId(String v) Set the resource version id for this feed.
void	setXmlBase(URI v) Sets the current xml:base attribute for this feed.

From class com.google.gdata.model.atom.Source

From class com.google.gdata.model.Element

From class java.lang.Object

From interface com.google.gdata.data.IAtom

abstract ILink	addLink(String rel, String type, String href) Adds a link with the given rel, type, and href.
abstract List<? extends IPerson>	getAuthors() Returns the list of all authors on this resource.
abstract Set<? extends ICategory>	getCategories() Returns a set of categories on this resource.
abstract String	getEtag() Gets the value of the gd:etag attribute for this resource.
abstract String	getId() Get the unique id for this resource.
abstract String	getKind() Returns the value of the gd:kind attribute for this resource.
abstract ILink	getLink(String rel, String type) Returns a particular atom:link element with the given rel and type, or null if one was not found.
abstract List<? extends ILink>	getLinks() Returns a list of atom:link elements on this resource.
abstract ILink	getSelfLink() Returns the self link for the resource.
abstract ITextConstruct	getTitle() Returns the atom:title element of this resource.
abstract DateTime	getUpdated() Get a `DateTime` instance representing the last time this resource was updated.
abstract String	getVersionId() Version ID.
abstract void	removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given `rel` and `type` values.
abstract void	removeLinks() Removes all links from the this resource.
abstract void	setEtag(String etag) Sets the value of the gd:etag attribute for this resource.
abstract void	setId(String id) Sets the unique id for this resource.
abstract void	setKind(String kind) Sets the value of the gd:kind attribute for this resource.
abstract void	setService(Service s) Sets the service that this resource is being used with.
abstract void	setUpdated(DateTime updated) Sets the last time this resource was updated.
abstract void	setVersionId(String versionId) Sets the versionId.

From interface com.google.gdata.data.IFeed

abstract IEntry	createEntry() Creates a new entry of the appropriate type for this feed.
abstract boolean	getCanPost() Returns true if this feed accepts entries POSTed to it.
abstract List<? extends IEntry>	getEntries() Returns a list of entries for this feed.
abstract ILink	getEntryPostLink() Returns the entry post link for the feed.
abstract ILink	getFeedBatchLink() Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.
abstract IGenerator	getGenerator() Returns the atom:generator element on this feed.
abstract int	getItemsPerPage() Gets the number of items that will be returned per page for paged feeds.
abstract String	getLogo() Returns the value of the atom:logo element.
abstract ILink	getNextLink() Returns the link that provides the URI of next page in a paged feed.
abstract ILink	getPreviousLink() Returns the link that provides the URI of previous page in a paged feed.
abstract int	getStartIndex() Gets the starting index of the contained entries for paged feeds.
abstract ITextConstruct	getSubtitle() Returns the atom:subtitle element of this feed.
abstract int	getTotalResults() Gets the total number of results associated with this feed.
abstract void	setCanPost(boolean canPost) Sets whether this feed accepts entries POSTed to it.
abstract IGenerator	setGenerator(String version, String uri, String name) Sets the atom:generator element on this feed.
abstract void	setItemsPerPage(int numResults) Sets the number of items that will be returned per page for paged feeds.
abstract void	setLogo(String logo) Sets the value of the logo field on this feed.
abstract void	setStartIndex(int startIndex) Sets the starting index of the contained entries for paged feeds.
abstract void	setTotalResults(int totalResults) Sets the total number of results associated with this feed.

Constants

public static final String KIND

Message kind term value.

Constant Value: "http://schemas.google.com/g/2005#message"

Fields

public static final Category CATEGORY

Message kind category.

public static final ElementKey<Void, MessageFeed> KEY

The key for this element.

Public Constructors

public MessageFeed ()

Constructs an instance using the default key.

public MessageFeed (Feed sourceFeed)

Constructs a new instance by doing a shallow copy of data from an existing Feed instance.

Parameters

sourceFeed	Source feed

Protected Constructors

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

Subclass constructor, allows subclasses to supply their own element key.

Parameters

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. 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 createElement(ElementKey, Element).

Parameters

key	The key to use for this element.
source	Source element

Public Methods

public List<? extends MessageEntry> getEntries ()

Returns the list of entries in this feed

public MessageFeed lock ()

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.

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters

registry

Classes

MessageFeed

Class Overview

Summary

Constants

public static final String KIND

Fields

public static final Category CATEGORY

public static final ElementKey<Void, MessageFeed> KEY

Public Constructors

public MessageFeed ()

public MessageFeed (Feed sourceFeed)

Parameters

Protected Constructors

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

Parameters

protected MessageFeed (ElementKey<?, ? extends MessageFeed> key, Feed source)

Parameters

Public Methods

public List<? extends MessageEntry> getEntries ()

public MessageFeed lock ()

public static void registerMetadata (MetadataRegistry registry)

Parameters