summaryrefslogtreecommitdiff
path: root/src/com/google/wireless/gdata2/data/Feed.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/com/google/wireless/gdata2/data/Feed.java')
-rw-r--r--src/com/google/wireless/gdata2/data/Feed.java58
1 files changed, 47 insertions, 11 deletions
diff --git a/src/com/google/wireless/gdata2/data/Feed.java b/src/com/google/wireless/gdata2/data/Feed.java
index 92d719a..76c9e8a 100644
--- a/src/com/google/wireless/gdata2/data/Feed.java
+++ b/src/com/google/wireless/gdata2/data/Feed.java
@@ -7,7 +7,6 @@ package com.google.wireless.gdata2.data;
* not contain any of the entries in that feed -- the entries are yielded
* separately from this Feed.
*/
-// TODO: comment that setters are only used for parsing code.
public class Feed {
private int totalResults;
private int startIndex;
@@ -25,26 +24,53 @@ public class Feed {
public Feed() {
}
+ /**
+ * The approximate number of total results in the feed
+ * @return totalResults
+ */
public int getTotalResults() {
return totalResults;
}
+ /**
+ * The number of toal results in the feed Only used during
+ * parsing of the feed
+ * @param totalResults
+ */
public void setTotalResults(int totalResults) {
this.totalResults = totalResults;
}
+ /**
+ * The starting Index of the current result set
+ * @return startIndex
+ */
public int getStartIndex() {
return startIndex;
}
+ /**
+ * The starting index of the current result set Only used during
+ * parsing of the feed
+ * @param startIndex
+ */
public void setStartIndex(int startIndex) {
this.startIndex = startIndex;
}
+ /**
+ * The number of items per Page in this result set
+ * @return itemsPerPage
+ */
public int getItemsPerPage() {
return itemsPerPage;
}
+ /**
+ * The number of items per page in this result set
+ * Only used during parsing of the feed
+ * @param itemsPerPage
+ */
public void setItemsPerPage(int itemsPerPage) {
this.itemsPerPage = itemsPerPage;
}
@@ -56,8 +82,10 @@ public class Feed {
return category;
}
- /**
- * @param category the category to set
+ /**
+ * The category to set
+ * Only used during parsing of the feed
+ * @param category
*/
public void setCategory(String category) {
this.category = category;
@@ -70,8 +98,10 @@ public class Feed {
return categoryScheme;
}
- /**
- * @param categoryScheme the categoryScheme to set
+ /**
+ * The categoryScheme to set
+ * Only used during parsing of the feed
+ * @param categoryScheme
*/
public void setCategoryScheme(String categoryScheme) {
this.categoryScheme = categoryScheme;
@@ -84,8 +114,10 @@ public class Feed {
return id;
}
- /**
- * @param id the id to set
+ /**
+ * the id to set
+ * Only used during parsing of the feed
+ * @param id
*/
public void setId(String id) {
this.id = id;
@@ -98,8 +130,10 @@ public class Feed {
return lastUpdated;
}
- /**
- * @param lastUpdated the lastUpdated to set
+ /**
+ * The lastUpdated to set
+ * Only used during parsing of the feed
+ * @param lastUpdated
*/
public void setLastUpdated(String lastUpdated) {
this.lastUpdated = lastUpdated;
@@ -112,8 +146,10 @@ public class Feed {
return title;
}
- /**
- * @param title the title to set
+ /**
+ * the title to set
+ * Only used during parsing of the feed
+ * @param title
*/
public void setTitle(String title) {
this.title = title;