diff --git a/pom.xml b/pom.xml
index f3b14fc..5a34169 100644
--- a/pom.xml
+++ b/pom.xml
@@ -40,5 +40,20 @@
+
+ <error>
elements in it.
*
- * There are eight different error codes returned:
+ * There are eight different error codes that can be returned:
*
*
ListIdentifiers
request.
- * Can be used to get a list of Headers
that holds identifiers.
+ * Can be used to get a list of Headers
that holds identifiers,
+ * i.e. asList()
will return a List<Header>
.
*
* @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 3ad7123..cb586d0 100644
--- a/src/main/java/se/kb/oai/pmh/ListBase.java
+++ b/src/main/java/se/kb/oai/pmh/ListBase.java
@@ -7,7 +7,7 @@ import org.dom4j.Document;
/**
* 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,
+ * of objects. For responses that don't return all of their results in one response,
* the ResumptionToken
to get the next set of data can also be
* retrieved.
*
diff --git a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
index 16693f8..50b6ce6 100644
--- a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
+++ b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
@@ -23,7 +23,8 @@ import org.dom4j.Node;
/**
* This class represents the response from a ListMetadataFormats
request
- * to the OAI-PMH server. Can be used to get a list of MetadataFormats
.
+ * to the OAI-PMH server. Can be used to get a list of MetadataFormats
,
+ * i.e. asList()
will return a List<MetadataFormat>
.
*
* @author Oskar Grenholm, National Library of Sweden
*/
@@ -47,8 +48,9 @@ public class MetadataFormatsList extends ListBaseListMetadataFormats
request will never
- * have a resumption token, so this method will throw a NoSuchMethodError
+ * Overrides getResumptionToken
in ListBase
and because
+ * the response from a ListMetadataFormats
request will never
+ * have a resumption token this method will throw a NoSuchMethodError
* to prevent it from being used in that way.
*/
@Override
diff --git a/src/main/java/se/kb/oai/pmh/RecordsList.java b/src/main/java/se/kb/oai/pmh/RecordsList.java
index ad4f7cb..d8437d0 100644
--- a/src/main/java/se/kb/oai/pmh/RecordsList.java
+++ b/src/main/java/se/kb/oai/pmh/RecordsList.java
@@ -24,7 +24,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a ListRecords
request.
* Can be used to get the list of Records
that made up the
- * response.
+ * response, i.e. asList()
will return a List<Record>
.
*
* @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 824bdcd..e7ab1a2 100644
--- a/src/main/java/se/kb/oai/pmh/SetsList.java
+++ b/src/main/java/se/kb/oai/pmh/SetsList.java
@@ -23,7 +23,8 @@ import org.dom4j.Node;
/**
* Class that represents the response from a ListSets
request.
- * Can be used to get a list of Sets
.
+ * Can be used to get a list of Sets
, i.e. asList()
+ * will return a List<Set>
.
*
* @author Oskar Grenholm, National Library of Sweden
*/