WorksheetFeed

extends BaseFeed<F extends BaseFeed, E extends BaseEntry>

java.lang.Object
↳	com.google.gdata.data.AbstractExtension
	↳	com.google.gdata.data.ExtensionPoint
		↳	com.google.gdata.data.Source
			↳	com.google.gdata.data.BaseFeed<F extends com.google.gdata.data.BaseFeed, E extends com.google.gdata.data.BaseEntry>
				↳	com.google.gdata.data.spreadsheet.WorksheetFeed

Class Overview

The feed for getting a list of worksheets within a sheet.

Summary

[Expand]

Inherited Fields

From class com.google.gdata.data.BaseFeed

From class com.google.gdata.data.Source

From class com.google.gdata.data.ExtensionPoint

From class com.google.gdata.data.AbstractExtension

Public Constructors
	WorksheetFeed() Constructs an empty feed.
	WorksheetFeed(BaseFeed sourceFeed) Constructs a new worksheet feed from an existing feed instance.

Public Methods
void	declareExtensions(ExtensionProfile extProfile) Declares feed-level extensions into the extension profile.

[Expand]

Inherited Methods

From class com.google.gdata.data.BaseFeed

void	addAdaptor(Kind.Adaptor adaptor) Associates a new `Kind.Adaptor` with this `Adaptable` instance.
E	createEntry() Creates a new entry for the feed.
void	declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The implementation of this method for BaseFeed will declare any extensions associated with the contained entry type.
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	generateFeedEnd(XmlWriter w) Closes everything that was opened by `generateFeedStart(ExtensionProfile, XmlWriter, Collection)`.
void	generateFeedStart(ExtensionProfile extProfile, XmlWriter w, Collection<XmlNamespace> namespaces) Generates everything that's in the feed up to and not including the entries.
void	generateRss(XmlWriter w, ExtensionProfile extProfile) Generates XML in the RSS format.
BaseFeed<?, ?>	getAdaptedFeed() Locates and returns the most specific `Kind.Adaptor` feed subtype for this feed.
<A extends Kind.Adaptor> A	getAdaptor(Class<A> adaptorClass)
Collection<Kind.Adaptor>	getAdaptors() Returns the collection of `Kind.Adaptor` instances associated with the this `Adaptable` instance.
boolean	getCanPost() Gets the property that indicates if it is possible to post new entries to the feed.
<T extends BaseEntry> List<T>	getEntries(Class<T> returnClass) Gets a list of entries of a particular kind.
List<E>	getEntries() Returns the list of entries in this feed
Link	getEntryPostLink() Returns the entry post link for the feed.
String	getEtag() Returns the current entity tag 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.
XmlParser.ElementHandler	getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the `AbstractExtension.AttributesHandler` to handle parsing the extension.
int	getItemsPerPage() Gets the number of items that will be returned per page for paged feeds.
String	getKind() Returns the current gd:kind attribute 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 current fields selection for this partial feed.
F	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 associated 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 entity version for this feed.
<T extends E extends BaseEntry> T	insert(T newEntry) Inserts a new Entry into the feed, if the feed is currently associated with a Service.
void	parseAtom(ExtensionProfile extProfile, XmlEventSource source) Parses XML in the Atom format from a parser-defined content source.
void	parseAtom(ExtensionProfile extProfile, InputStream input) Parses XML in the Atom format.
void	parseAtom(ExtensionProfile extProfile, Reader reader) Parses XML in the Atom format.
static <F extends BaseFeed> F	readFeed(ParseSource source, Class<F> feedClass, ExtensionProfile extProfile) This method provides the base implementation of feed reading using either static or dynamic typing.
static BaseFeed<?, ?>	readFeed(ParseSource source) Reads a feed representation from the provided `ParseSource`.
void	setCanPost(boolean v) Sets the property that indicates if it is possible to post new entries to the feed.
void	setEntries(List<E> entryList) Sets the list to use for storing the entry list
void	setEtag(String v) Sets the current entity tag 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 current gd:kind attribute value for this feed.
void	setSelectedFields(String fields) Sets the current fields selection for this partial 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) Sets the entity version for this feed.
void	visitChildren(ExtensionVisitor ev) Called to visit all children of this extension point.

From class com.google.gdata.data.Source

From class com.google.gdata.data.ExtensionPoint

From class com.google.gdata.data.AbstractExtension

From class java.lang.Object

From interface com.google.gdata.data.Extension

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.

From interface com.google.gdata.data.Kind.Adaptable

From interface com.google.gdata.data.Kind.Adaptor

Public Constructors

public WorksheetFeed ()

Constructs an empty feed.

public WorksheetFeed (BaseFeed sourceFeed)

Constructs a new worksheet feed from an existing feed instance.

Parameters

sourceFeed

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Declares feed-level extensions into the extension profile.

Parameters

extProfile	The ExtensionProfile to initialize.

Classes

Enums

WorksheetFeed

Class Overview

Summary

Public Constructors

public WorksheetFeed ()

public WorksheetFeed (BaseFeed sourceFeed)

Parameters

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Parameters