Summary: Methods | [Expand All]

public interface

IAtom

com.google.gdata.data.IAtom

Known Indirect Subclasses

AbPageVariationEntry, AbPageVariationFeed, AccountEntry, AccountFeed, AclEntry, AclFeed, ActivityEntry, ActivityFeed, AlbumEntry, AlbumFeed, AnnouncementEntry, AnnouncementsPageEntry, ArchiveEntry, ArchiveFeed, AttachmentEntry, and 197 others.

AbPageVariationEntry	Entry element for abpagevariation feed.
AbPageVariationFeed	Feed element in AbPageVariationFeed.
AccountEntry	Entry element for account feed.
AccountFeed	Feed element in account feed.
AclEntry	Defines an entry in a feed of an access control list (ACL).
AclFeed	Defines a feed of an access control list (ACL).
ActivityEntry	An entry representing a user action in a site.
ActivityFeed	Describes an activity feed.
AlbumEntry	Entry for album kinds, contains album metadata.
AlbumFeed	Feed for an Album in our google photos api.
AnnouncementEntry	Describes an announcement entry.
AnnouncementsPageEntry	Describes an announcements page entry.
ArchiveEntry	Describes an Archive entry.
ArchiveFeed	Describes an Archive feed.
AttachmentEntry	Describes an attachment entry.
AttendeeEntry	This is used to represent an entry in an attendee feed.
AttendeeFeed	For attendee feeds
AudioEntry	An entry representing a single audio file with a `DocumentListFeed`.
BaseActivityEntry<E extends BaseActivityEntry<E>>	An entry representing a user action in a site.
BaseContentEntry<E extends BaseContentEntry<E>>	An entry representing a single content item.
BaseDocumentListEntry<E>	Class that glues `ChangelogEntry` which was generated by the genesis tool to its hand-written superclass (`DocumentListEntry`).
BaseEntry<E extends BaseEntry>	The BaseEntry class is an abstract base class that defines the in-memory object model for GData entries.
BaseEventEntry<E extends BaseEventEntry<E>>	Customizes the base entry to define an event entry.
BaseEventFeed<F extends BaseEventFeed<F, E extends BaseEventEntry<E>>, E>	Customizes the base feed class to define a feed of events.
BaseFeed<F extends BaseFeed, E extends BaseEntry>	The BaseFeed class is an abstract base class that represents a generic GData feed object, based primarily on the data model for an `<atom:feed>` element.
BaseHealthEntry<E extends BaseHealthEntry>	Describes a health entry.
BaseHealthFeed<F extends BaseHealthFeed, E extends BaseHealthEntry>	Describes a health feed.
BasePageEntry<E extends BasePageEntry<E>>	An entry representing a page in the site.
BasePersonEntry<E extends BasePersonEntry<E>>	Describes a person entry.
BlogCommentFeed	Describes a feed of an entire blog's comments.
BlogEntry	Describes a blog entry in the feed of a user's blogs.
BlogFeed	Describes a feed of a user's blogs.
BlogPostFeed	Describes a feed of a blog's posts.
BrixEntry	Describes a Brix document entry.
CalendarAclEntry	Describes an entry in a feed of a Calendar access control list (ACL).
CalendarEntry	This represents a single calendar in a list of calendars.
CalendarEventEntry	This extends the EventEntry class for event entries in Google Calendars,
CalendarEventFeed	Describes a Calendar event feed.
CalendarFeed	Describes a feed of Calendars.
CaptionTrackEntry	A caption track.
CaptionTrackFeed	A feed of `CaptionTrackEntry`
CellEntry	Atom Entry for a single cell for the Google Spreadsheets cells feed.
CellFeed	The feed for spreadsheet cells of Google Spreadsheets.
ChangelogEntry	Describes an entry representing a single changed document of any type.
ChangelogFeed	Describes a feed for retrieving a list of changed documents.
ChannelEntry	An atom entry containing a channel.
ChannelFeed	Feed containing channels.
CodeSearchEntry	Used to represent the results of a code query in a single file.
CodeSearchFeed	The CodeSearchFeed class customizes the generic BaseFeed class to define a feed to search for code.
CollectionEntry	Describes an entry in a feed of collections.
CollectionFeed	Describes a Book Search collection feed.
CombinationEntry	Entry element for combination feed.
CombinationFeed	Feed element in CombinationFeed.
CommentEntry	An entry in the comment feed.
CommentFeed	Object representation for the comment feed.
ComplaintEntry	A complaint.
ComplaintFeed	A feed that contains a list of `ComplaintEntry`.
ContactEntry	This class is deprecated. Please use `ContactEntry` instead.
ContactFeed	This class is deprecated. Please use `ContactFeed` instead.
ContactGroupEntry	Describes a contact group entry.
ContactGroupFeed	Describes a contact group feed.
ContentEntry	An entry representing a single content item.
ContentFeed	Describes a content feed.
CrawlIssueEntry	Describes a crawl issue entry.
CrawlIssuesFeed	Feed of crawl issues for a particular site.
CreationActivityEntry	An activity entry for content creation.
DataEntry	Entry element for data feed.
DataFeed	Feed element in data feed.
DeletionActivityEntry	An activity entry for content deletion.
DocumentEntry	Describes a document entry.
DocumentExportEntry	Describes an entry representing a request to bulk export documents from a user.
DocumentExportFeed	Describes a feed for a list of export requests.
DocumentFeed	Describes a document feed.
DocumentListEntry	An entry representing a single document of any type within a `DocumentListFeed`.
DocumentListFeed	A feed for managing lists of documents from the Google Docs & Spreadsheets.
DrawingEntry	An entry representing a single drawing within a `DocumentListFeed`.
EditActivityEntry	An activity entry for a content edit.
EmailListEntry
EmailListFeed
EmailListRecipientEntry	Google Apps for Your Domain GData Entry which models a particular recipient on an email list.
EmailListRecipientFeed
Entry	The Entry class is a base class that defines the in-memory object model for GData entries.
EventEntry	Describes an event entry.
EventFeed	Describes an event feed.
ExperimentEntry	Entry element for experiment feed.
ExperimentFeed	Feed element in ExperimentFeed.
FavoriteEntry	A YouTube video favorite entry.
FavoriteFeed	A YouTube favorite feed.
FeatureEntry	Describes a feature entry.
FeatureFeed	Describes a feature feed.
Feed	The Feed class is a base class that represents a generic GData feed object, based primarily on the data model for an `<atom:feed>` element.
FeedLinkEntry<T extends BaseEntry>	An entry that's actually a glorified feed link, used in playlists and subscription feeds.
FileCabinetPageEntry	Describes a file cabinet page entry.
FileEntry	An entry representing a single file within a `DocumentListFeed`.
FolderEntry	An entry representing a folder in a FolderFeed.
FriendEntry	An entry that corresponds to a youtube contact/friend as displayed on the user contacts feed.
FriendFeed	A feed that contains a list of `FriendEntry`.
GenericEntry	GData entry class that models a generic feed entry which contains only name-value pairs of data.
GenericFeed	GData feed class that models a generic feed which simply contains a list of generic entries, each have nothing more than a set of key-value pairs.
GlossaryEntry	Describes a glossary entry.
GlossaryFeed	Describes a glossary feed.
GoogleBaseEntry	An object corresponding to one entry in a Google Base Atom XML file.
GoogleBaseFeed	An ATOM feed containing entries of type `GoogleBaseEntry`.
GoogleBaseMediaEntry	Media entry representing a media attachment of a Google Base item.
GoogleBaseMediaFeed	Media feed used for managing the media attachments for one Google Base Item.
GphotoEntry<E extends GphotoEntry<E>>	The base entry class for Picasaweb data.
GphotoFeed<F extends GphotoFeed>	This class customizes the generic MediaFeed class to define a feed of GphotoEntries.
IEntry	Shared interface for model and data BaseEntry to implement.
IFeed	Shared interface for model and data BaseFeed to implement.
IMediaEntry	The IMediaEntry interface defines a common base interface for GData media entries that is shared between the old and new data models.
IssueCommentsEntry	Describes an issue comments entry.
IssueCommentsFeed	Describes an issue comments feed.
IssuesEntry	Google Code Project Issues Feed entry.
IssuesFeed	Google Code Project Issues Feed.
KeywordEntry	Describes a keyword entry.
KeywordsFeed	Feed of keywords for a particular site.
ListEntry	Atom Entry for one single row Google Spreadsheets in the list-based access mode.
ListFeed	The feed for treating a spreadsheet as a collection of list items.
ListItemEntry	Describes a list item entry.
ListPageEntry	Describes a list page entry.
MailItemEntry	Used by a MailItemFeedProvider to represent a single MailItemEntry in a list of MailItems.
MailItemFeed	The MailItemFeed class customizes the generic BaseEntry class to define a feed of MailItem entries.
ManagementEntry	Entry element for GA data source feed.
ManagementFeed	Feed element in data source feed.
MapEntry	Describes a map entry.
MapFeed	Describes a map feed.
MediaEntry<E extends BaseEntry<E>>	The MediaEntry class is an abstract base class for GData services that support media content.
MediaFeed<F extends BaseFeed, E extends BaseEntry>	The MediaFeed class extends `BaseFeed` to add media-related operations for feeds that contain media content.
MessageEntry	Extension class for manipulating entries of the Message kind.
MessageFeed	Describes a message feed.
MessagesFeed	The MessagesFeed class extends the BaseFeed class to define a feed of messages.
MetadataEntry	Describes a Metadata entry.
MetadataFeed	Describes an Metadata feed.
MoveActivityEntry	An activity entry for a content move.
NicknameEntry
NicknameFeed
PageEntry	An entry representing a page in the site.
PdfEntry	An entry representing a single PDF within a `DocumentListFeed`.
PersonEntry	Describes a person entry.
PhotoEntry	Entry for photo kinds, contains photo metadata.
PhotoFeed	Feed for a Photo in our google data api.
PlaylistEntry	A YouTube playlist entry.
PlaylistFeed	A YouTube playlist feed.
PlaylistLinkEntry	Entries that appear on the user playlist feed.
PlaylistLinkFeed	A feed that contains playlist link entries.
PortfolioEntry	Describes an entry in a feed of Finance portfolios.
PortfolioFeed	Describes a Finance portfolio feed.
PositionEntry	Describes an entry in a feed of Finance positions.
PositionFeed	Describes a Finance position feed.
PostCommentFeed	Describes a feed of a blog post's comments.
PostEntry	Describes a blog post entry.
PresentationEntry	An entry representing a single presentation within a `DocumentListFeed`.
ProfileEntry	Describes a profile entry.
ProfileFeed	Describes a profile feed.
ProjectSummaryEntry	Google Code Project Summary Entry.
ProjectsFeed	Google Code Projects Feed.
RatingEntry	An entry in the rating feed.
RatingFeed	Object representatino for the rating feed.
RecordEntry	Describes a record entry in the feed of a table's records.
RecordFeed	Describes a feed of a table's records.
RecoveryActivityEntry	An activity entry for content recovery.
RecurrenceExceptionEntry	Describes an entry used by a recurrence exception entry link.
RegisterEntry	Describes a register entry.
RegisterFeed	Describes a register feed.
RevisionEntry	Defines an entry in a feed of revisions of a document.
RevisionFeed	A read-only feed from which a particular version of a document can be fetched.
SectionEntry	Entry element for section feed.
SectionFeed	Feed element in SectionFeed.
SidewikiEntry	Describes a Sidewiki entry in the feed of Sidewiki entries.
SidewikiEntryFeed	Describes a feed of Sidewiki entries.
SidewikiUserEntry	Describes a Sidewiki user entry.
SidewikiUserFeed	Describes a feed of Sidewiki users.
SiteEntry	An entry representing a site.
SiteFeed	Describes a site feed.
SitemapsEntry<E extends SitemapsEntry<E>>	Defines an abstract base class for sitemap entry.
SitemapsFeed	The SitemapsFeed class customizes the generic BaseFeed class to define a feed of sitemaps that Webmaster Tools user has for a given site.
SitemapsMobileEntry	This represents a single Mobile sitemap entry in a list of sitemaps.
SitemapsNewsEntry	This represents a single News sitemap entry in a list of sitemaps.
SitemapsRegularEntry	This represents a single regular sitemap entry in a list of sitemaps.
SitesEntry	This represents a single web site entry.
SitesFeed	The SitesFeed class customizes the generic BaseFeed class to define a feed of web sites that Webmaster Tools user has.
SpreadsheetEntry	One spreadsheet, when listing all spreadsheets you have access to.
SpreadsheetFeed	The feed for getting a list of Spreadsheets within a sheet.
SubscriptionEntry	Entries that appear on the publisher playlist feed.
SubscriptionFeed	A feed that contains playlist link entries.
TableEntry	Describes a table entry in the feed of a spreadsheet's tables.
TableFeed	Describes a feed of a spreadsheet's tables.
TagEntry	Entry for tag kinds, contains tag metadata.
TransactionEntry	Describes an entry in a feed of Finance transactions.
TransactionFeed	Describes a Finance transaction feed.
TranslationMemoryEntry	Describes a translation memory entry.
TranslationMemoryFeed	Describes a translation memory feed.
UserEntry	Entry for user kinds, contains user metadata.
UserEventEntry	An atom entry containing a user event.
UserEventFeed	A feed that contains user event entries.
UserFeed	Feed for a User in our google photos api.
UserProfileEntry	An atom entry containing a user profile.
UserProfileFeed	Feed containing user profiles.
VariationEntry	Entry element for variation feed.
VariationFeed	Feed element in VariationFeed.
VersionEntry	Describes a version entry.
VersionFeed	Describes a version feed.
VideoEntry	Video entry for the youtube feeds.
VideoFeed	Video feed returned by the feed providers.
VideoMessageEntry	A YouTube shared video entry.
VideoMessageFeed	Shared video feed (inbox).
VolumeEntry	Describes an entry in a feed of Book Search volumes.
VolumeFeed	Describes a Book Search volume feed.
WebAttachmentEntry	Describes a web attachment entry.
WebPageEntry	Describes a web page entry.
WorksheetEntry	One worksheet, when listing all worksheets within a spreadsheet.
WorksheetFeed	The feed for getting a list of worksheets within a sheet.

Class Overview

Base interface for Atom resource types. Contains a common set of methods across both entries and feeds and a can also be used as a parameter type in contexts where either a feed or an entry is acceptable.

Summary

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

Public Methods

public abstract ILink addLink (String rel, String type, String href)

Adds a link with the given rel, type, and href.

Parameters

rel
type
href

public abstract List<? extends IPerson> getAuthors ()

Returns the list of all authors on this resource.

public abstract Set<? extends ICategory> getCategories ()

Returns a set of categories on this resource.

public abstract String getEtag ()

Gets the value of the gd:etag attribute for this resource. See RFC 2616, Section 3.11.

public abstract String getId ()

Get the unique id for this resource. Represents the atom:id element.

public abstract String getKind ()

Returns the value of the gd:kind attribute for this resource. Returns null if the kind attribute is missing.

public 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.

Parameters

rel
type

public abstract List<? extends ILink> getLinks ()

Returns a list of atom:link elements on this resource. If there are no links, an empty list will be returned.

public abstract ILink getSelfLink ()

Returns the self link for the resource.

public abstract ITextConstruct getTitle ()

Returns the atom:title element of this resource.

public abstract DateTime getUpdated ()

Get a DateTime instance representing the last time this resource was updated. Represents the atom:updated element.

public abstract String getVersionId ()

Version ID. This is a unique number representing this particular resource. Every update changes the version ID (unless the update doesn't modify anything, in which case it's permissible for version ID to stay the same). Services are free to interpret this string in the most convenient way. Some services may choose to use a monotonically increasing sequence of version IDs. Other services may compute a hash of entry properties or feed content and use that.

This property is only used for services to communicate the current version ID back to the servlet. It is NOT set when resources are parsed (either from requests or from arbitrary XML).

public abstract void removeLinks (String relToMatch, String typeToMatch)

Remove all links that match 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.

public abstract void removeLinks ()

Removes all links from the this resource.

public abstract void setEtag (String etag)

Sets the value of the gd:etag attribute for this resource.

Parameters

etag

public abstract void setId (String id)

Sets the unique id for this resource.

Parameters

id

public abstract void setKind (String kind)

Sets the value of the gd:kind attribute for this resource. A value of null will remove the kind attribute.

Parameters

kind

public abstract void setService (Service s)

Sets the service that this resource is being used with.

Parameters

s

public abstract void setUpdated (DateTime updated)

Sets the last time this resource was updated.

Parameters

updated

public abstract void setVersionId (String versionId)

Sets the versionId. See getVersionId() for a description of what the versionId is used for.

Parameters

versionId

Interfaces

Classes

Annotations

Enums

Exceptions

IAtom

Class Overview

See Also

Summary

Public Methods

public abstract ILink addLink (String rel, String type, String href)

Parameters

public abstract List<? extends IPerson> getAuthors ()

public abstract Set<? extends ICategory> getCategories ()

public abstract String getEtag ()

public abstract String getId ()

public abstract String getKind ()

public abstract ILink getLink (String rel, String type)

Parameters

public abstract List<? extends ILink> getLinks ()

public abstract ILink getSelfLink ()

public abstract ITextConstruct getTitle ()

public abstract DateTime getUpdated ()

public abstract String getVersionId ()

public abstract void removeLinks (String relToMatch, String typeToMatch)

Parameters

public abstract void removeLinks ()

public abstract void setEtag (String etag)

Parameters

public abstract void setId (String id)

Parameters

public abstract void setKind (String kind)

Parameters

public abstract void setService (Service s)

Parameters

public abstract void setUpdated (DateTime updated)

Parameters

public abstract void setVersionId (String versionId)

Parameters