Added Javadocs to ListBase.java

git-svn-id: https://oai4j-client.svn.sourceforge.net/svnroot/oai4j-client/trunk@8 201c9376-5148-0410-b534-98494c770f31
This commit is contained in:
bobcat_zed 2008-03-16 19:39:36 +00:00
parent c5f717e405
commit 291581370f
5 changed files with 23 additions and 7 deletions

View File

@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a <code>ListIdentifiers</code> request.
* You can use it to get a list of <code>Headers</code> that holds identifiers.
* Can be used to get a list of <code>Headers</code> that holds identifiers.
*
* @author Oskar Grenholm, National Library of Sweden
*/

View File

@ -4,10 +4,26 @@ import java.util.List;
import org.dom4j.Document;
public class ListBase<T> 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 <code>ResumptionToken</code> to get the next set of data can also be
* retrieved.
*
* @author Oskar Grenholm, National Library of Sweden
*/
public abstract class ListBase<T> extends ResponseBase {
protected List<T> list;
/**
* Constructor.
*
* @param the response
*
* @throws ErrorResponseException
*/
public ListBase(Document document) throws ErrorResponseException {
super(document);
}
@ -22,9 +38,9 @@ public class ListBase<T> extends ResponseBase {
}
/**
* Get a the content of the response as a list of type <code>T</code>.
* Get the content of the response as a list with objects of type <code>T</code>.
*
* @return a list with objects of type <code>T</code>
* @return the list
*/
public List<T> asList() {
return list;

View File

@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* This class represents the response from a <code>ListMetadataFormats</code> request
* to the OAI-PMH server. You can use it to get a list of <code>MetadataFormats</code>.
* to the OAI-PMH server. Can be used to get a list of <code>MetadataFormats</code>.
*
* @author Oskar Grenholm, National Library of Sweden
*/

View File

@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a <code>ListRecords</code> request.
* You can use it to get the list of <code>Records</code> that made up the
* Can be used to get the list of <code>Records</code> that made up the
* response.
*
* @author Oskar Grenholm, National Library of Sweden

View File

@ -23,7 +23,7 @@ import org.dom4j.Node;
/**
* Class that represents the response from a <code>ListSets</code> request.
* You can use it to get a list of <code>Sets</code>.
* Can be used to get a list of <code>Sets</code>.
*
* @author Oskar Grenholm, National Library of Sweden
*/