diff --git a/src/main/java/se/kb/oai/pmh/IdentifiersList.java b/src/main/java/se/kb/oai/pmh/IdentifiersList.java
index 06b99d8..f60498a 100644
--- a/src/main/java/se/kb/oai/pmh/IdentifiersList.java
+++ b/src/main/java/se/kb/oai/pmh/IdentifiersList.java
@@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a ListIdentifiers
request.
- * You can use it to get a list of Headers
that holds identifiers.
+ * Can be used to get a list of Headers
that holds identifiers.
*
* @author Oskar Grenholm, National Library of Sweden
*/
diff --git a/src/main/java/se/kb/oai/pmh/ListBase.java b/src/main/java/se/kb/oai/pmh/ListBase.java
index 46aafcd..3ad7123 100644
--- a/src/main/java/se/kb/oai/pmh/ListBase.java
+++ b/src/main/java/se/kb/oai/pmh/ListBase.java
@@ -4,10 +4,26 @@ import java.util.List;
import org.dom4j.Document;
-public class ListBase extends ResponseBase {
+/**
+ * Abstract base class that holds common functionality for the responses that
+ * return lists. Can be used to get the size of the list and the actual list
+ * of objects. For respones that don't return all of their results in one response,
+ * the ResumptionToken
to get the next set of data can also be
+ * retrieved.
+ *
+ * @author Oskar Grenholm, National Library of Sweden
+ */
+public abstract class ListBase extends ResponseBase {
protected List list;
+ /**
+ * Constructor.
+ *
+ * @param the response
+ *
+ * @throws ErrorResponseException
+ */
public ListBase(Document document) throws ErrorResponseException {
super(document);
}
@@ -22,9 +38,9 @@ public class ListBase extends ResponseBase {
}
/**
- * Get a the content of the response as a list of type T
.
+ * Get the content of the response as a list with objects of type T
.
*
- * @return a list with objects of type T
+ * @return the list
*/
public List asList() {
return list;
diff --git a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
index 7532e90..16693f8 100644
--- a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
+++ b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
@@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* This class represents the response from a ListMetadataFormats
request
- * to the OAI-PMH server. You can use it to get a list of MetadataFormats
.
+ * to the OAI-PMH server. Can be used to get a list of MetadataFormats
.
*
* @author Oskar Grenholm, National Library of Sweden
*/
diff --git a/src/main/java/se/kb/oai/pmh/RecordsList.java b/src/main/java/se/kb/oai/pmh/RecordsList.java
index 2cab881..ad4f7cb 100644
--- a/src/main/java/se/kb/oai/pmh/RecordsList.java
+++ b/src/main/java/se/kb/oai/pmh/RecordsList.java
@@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a ListRecords
request.
- * You can use it to get the list of Records
that made up the
+ * Can be used to get the list of Records
that made up the
* response.
*
* @author Oskar Grenholm, National Library of Sweden
diff --git a/src/main/java/se/kb/oai/pmh/SetsList.java b/src/main/java/se/kb/oai/pmh/SetsList.java
index 04b8d71..824bdcd 100644
--- a/src/main/java/se/kb/oai/pmh/SetsList.java
+++ b/src/main/java/se/kb/oai/pmh/SetsList.java
@@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a ListSets
request.
- * You can use it to get a list of Sets
.
+ * Can be used to get a list of Sets
.
*
* @author Oskar Grenholm, National Library of Sweden
*/