Changed pom.xml to build better Javadoc. Also improved the existing Javadocs on some classes in minor ways.
git-svn-id: https://oai4j-client.svn.sourceforge.net/svnroot/oai4j-client/trunk@9 201c9376-5148-0410-b534-98494c770f31
This commit is contained in:
parent
291581370f
commit
1f9012dea4
15
pom.xml
15
pom.xml
|
@ -41,4 +41,19 @@
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
|
|
||||||
|
<reporting>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-javadoc-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<links>
|
||||||
|
<value>http://java.sun.com/javase/6/docs/api/</value>
|
||||||
|
<value>http://www.dom4j.org/apidocs/</value>
|
||||||
|
</links>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</reporting>
|
||||||
|
|
||||||
</project>
|
</project>
|
||||||
|
|
|
@ -24,7 +24,7 @@ import se.kb.oai.OAIException;
|
||||||
* Exception that is thrown when the response from the OAI-PMH server
|
* Exception that is thrown when the response from the OAI-PMH server
|
||||||
* has <code><error></code> elements in it.
|
* has <code><error></code> elements in it.
|
||||||
*
|
*
|
||||||
* There are eight different error codes returned:
|
* There are eight different error codes that can be returned:
|
||||||
*
|
*
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li> badArgument
|
* <li> badArgument
|
||||||
|
|
|
@ -23,7 +23,8 @@ import org.dom4j.Node;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class that represents the response from a <code>ListIdentifiers</code> request.
|
* Class that represents the response from a <code>ListIdentifiers</code> request.
|
||||||
* Can be used 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,
|
||||||
|
* i.e. <code>asList()</code> will return a <code>List<Header></code>.
|
||||||
*
|
*
|
||||||
* @author Oskar Grenholm, National Library of Sweden
|
* @author Oskar Grenholm, National Library of Sweden
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -7,7 +7,7 @@ import org.dom4j.Document;
|
||||||
/**
|
/**
|
||||||
* Abstract base class that holds common functionality for the responses that
|
* 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
|
* 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 <code>ResumptionToken</code> to get the next set of data can also be
|
* the <code>ResumptionToken</code> to get the next set of data can also be
|
||||||
* retrieved.
|
* retrieved.
|
||||||
*
|
*
|
||||||
|
|
|
@ -23,7 +23,8 @@ import org.dom4j.Node;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This class represents the response from a <code>ListMetadataFormats</code> request
|
* This class represents the response from a <code>ListMetadataFormats</code> request
|
||||||
* to the OAI-PMH server. Can be used to get a list of <code>MetadataFormats</code>.
|
* to the OAI-PMH server. Can be used to get a list of <code>MetadataFormats</code>,
|
||||||
|
* i.e. <code>asList()</code> will return a <code>List<MetadataFormat></code>.
|
||||||
*
|
*
|
||||||
* @author Oskar Grenholm, National Library of Sweden
|
* @author Oskar Grenholm, National Library of Sweden
|
||||||
*/
|
*/
|
||||||
|
@ -47,8 +48,9 @@ public class MetadataFormatsList extends ListBase<MetadataFormat> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The response from a <code>ListMetadataFormats</code> request will never
|
* Overrides <code>getResumptionToken</code> in <code>ListBase</code> and because
|
||||||
* have a resumption token, so this method will throw a <code>NoSuchMethodError</code>
|
* the response from a <code>ListMetadataFormats</code> request will never
|
||||||
|
* have a resumption token this method will throw a <code>NoSuchMethodError</code>
|
||||||
* to prevent it from being used in that way.
|
* to prevent it from being used in that way.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
|
|
@ -24,7 +24,7 @@ import org.dom4j.Node;
|
||||||
/**
|
/**
|
||||||
* Class that represents the response from a <code>ListRecords</code> request.
|
* Class that represents the response from a <code>ListRecords</code> request.
|
||||||
* Can be used 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.
|
* response, i.e. <code>asList()</code> will return a <code>List<Record></code>.
|
||||||
*
|
*
|
||||||
* @author Oskar Grenholm, National Library of Sweden
|
* @author Oskar Grenholm, National Library of Sweden
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -23,7 +23,8 @@ import org.dom4j.Node;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class that represents the response from a <code>ListSets</code> request.
|
* Class that represents the response from a <code>ListSets</code> request.
|
||||||
* Can be used to get a list of <code>Sets</code>.
|
* Can be used to get a list of <code>Sets</code>, i.e. <code>asList()</code>
|
||||||
|
* will return a <code>List<Set></code>.
|
||||||
*
|
*
|
||||||
* @author Oskar Grenholm, National Library of Sweden
|
* @author Oskar Grenholm, National Library of Sweden
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue