Fixed javadocs, added their compilation to the CI build configuration.

Resolves https://jira.duraspace.org/browse/FCREPO-1556
fcrepo-exts · Jun 2, 2015 · 7277e05 · 7277e05
1 parent 620170a
commit 7277e05
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 0 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,5 +4,11 @@ jdk:
 before_install:
   - "echo $JAVA_OPTS"
   - "export JAVA_OPTS=-Xmx512m"
+
+script:
+  - mvn install -B -V
+  - mvn javadoc:jar
+  - mvn javadoc:test-aggregate
+
 notifications:
   irc: "irc.freenode.org#fcrepo"
diff --git a/pom.xml b/pom.xml
@@ -176,6 +176,11 @@
           <target>1.8</target>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugin</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.3</version>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>

diff --git a/src/main/java/org/fcrepo/migration/ContentDigest.java b/src/main/java/org/fcrepo/migration/ContentDigest.java
@@ -9,6 +9,8 @@ public interface ContentDigest {
 
     /**
      * Gets the type: one of several defined in the fedora foxml schema.
+     *
+     * @return string containing the type
      */
     public String getType();
 

diff --git a/src/main/java/org/fcrepo/migration/foxml11/AkubraFSIDResolver.java b/src/main/java/org/fcrepo/migration/foxml11/AkubraFSIDResolver.java
@@ -17,6 +17,7 @@ public class AkubraFSIDResolver extends DirectoryScanningIDResolver {
      * Basic constructor.
      * @param indexDir A directory that will serve as a lucene index directory to cache ID resolution.
      * @param dsRoot the root directory of the AkubraFS datastream store.
+     * @throws IOException
      */
     public AkubraFSIDResolver(final File indexDir, final File dsRoot) throws IOException {
         super(indexDir, dsRoot);
@@ -25,6 +26,7 @@ public AkubraFSIDResolver(final File indexDir, final File dsRoot) throws IOExcep
     /**
      * Basic constructor.
      * @param dsRoot the root directory of the AkubraFS datastream store.
+     * @throws IOException
      */
     public AkubraFSIDResolver(final File dsRoot) throws IOException {
         super(null, dsRoot);

diff --git a/src/main/java/org/fcrepo/migration/foxml11/DirectoryScanningIDResolver.java b/src/main/java/org/fcrepo/migration/foxml11/DirectoryScanningIDResolver.java
@@ -132,6 +132,9 @@ private void indexDatastreams(final IndexWriter writer, final File f) throws IOE
 
     /**
      * Determines the internal id for the given file.
+     *
+     * @param f file to check for
+     * @return string containing internal id for the file
      */
     protected abstract String getInternalIdForFile(File f);
 

diff --git a/src/main/java/org/fcrepo/migration/foxml11/FoxmlDirectoryDFSIterator.java b/src/main/java/org/fcrepo/migration/foxml11/FoxmlDirectoryDFSIterator.java
@@ -33,6 +33,7 @@ public class FoxmlDirectoryDFSIterator implements Iterator<FedoraObjectProcessor
      * foxml directory DFS iterator.
      * @param root the root file
      * @param fetcher the fetcher
+     * @param localFedoraServer uri to local fedora server
      */
     public FoxmlDirectoryDFSIterator(final File root, final URLFetcher fetcher, final String localFedoraServer) {
         stack = new Stack<List<File>>();

diff --git a/src/main/java/org/fcrepo/migration/foxml11/LegacyFSIDResolver.java b/src/main/java/org/fcrepo/migration/foxml11/LegacyFSIDResolver.java
@@ -15,6 +15,7 @@ public class LegacyFSIDResolver extends DirectoryScanningIDResolver {
      * Basic constructor.
      * @param indexDir A directory that will serve as a lucene index directory to cache ID resolution.
      * @param dsRoot the root directory of the AkubraFS datastream store.
+     * @throws IOException
      */
     public LegacyFSIDResolver(final File indexDir, final File dsRoot) throws IOException {
         super(indexDir, dsRoot);
@@ -23,6 +24,7 @@ public LegacyFSIDResolver(final File indexDir, final File dsRoot) throws IOExcep
     /**
      * Basic constructor.
      * @param dsRoot the root directory of the AkubraFS datastream store.
+     * @throws IOException
      */
     public LegacyFSIDResolver(final File dsRoot) throws IOException {
         super(null, dsRoot);

diff --git a/src/main/java/org/fcrepo/migration/foxml11/NativeFoxmlDirectoryObjectSource.java b/src/main/java/org/fcrepo/migration/foxml11/NativeFoxmlDirectoryObjectSource.java
@@ -32,6 +32,7 @@ public class NativeFoxmlDirectoryObjectSource implements ObjectSource {
      *                 references to internally managed datastreams.
      * @param localFedoraServer the domain and port for the server that hosted the fedora objects in the format
      *                          "localhost:8080".
+     * @throws IOException
      */
     public NativeFoxmlDirectoryObjectSource(final File objectStore,
             final InternalIDResolver resolver, final String localFedoraServer) throws IOException {

diff --git a/src/main/java/org/fcrepo/migration/handlers/BasicObjectVersionHandler.java b/src/main/java/org/fcrepo/migration/handlers/BasicObjectVersionHandler.java
@@ -74,6 +74,7 @@ public class BasicObjectVersionHandler implements FedoraObjectVersionHandler {
      * Basic object version handler.
      * @param repo the fedora repository
      * @param idMapper the id mapper
+     * @param localFedoraServer uri to fedora server
      */
     public BasicObjectVersionHandler(final FedoraRepository repo, final MigrationIDMapper idMapper,
                                      final String localFedoraServer) {
@@ -246,6 +247,7 @@ protected void updateObjectProperties(final ObjectVersionReference version,
      * @param obj               Object of property to map from 3 to 4.
      * @param triplesToRemove   List of triples to remove from resource.
      * @param triplesToInsert   List of triples to add to resource.
+     * @param isLiteral         TRUE if obj is a literal triple, FALSE if a URI
      *
      * @throws FedoraException on error
      */
@@ -292,6 +294,7 @@ protected void mapProperty(final String origPred,
      * WIP utility function to update datastream properties.
      * Feel free to override this to suit your needs.
      *
+     * @param obj   Object to operate upon
      * @param v     Version of the datasream to update.
      * @param ds    Datastream to update.
      */
@@ -588,6 +591,8 @@ protected void updateUriTriple(final QuadAcc triplesToRemove,
      *
      * @param uri to be resolved
      *
+     * @return string which is either the migrated URI or the unmodified URI
+     *
      * @throws org.fcrepo.client.FedoraException on error
      */
     protected String resolveInternalURI(final String uri) throws FedoraException {
@@ -624,6 +629,8 @@ protected void createPlaceholder(final String path) throws FedoraException {
      *
      * @param o to be tested as a placeholder resource
      *
+     * @return TRUE if the object is a placeholder obj, FALSE if its an actual migrated object
+     *
      * @throws org.fcrepo.client.FedoraException
      */
     protected boolean isPlaceholder(final FedoraObject o) throws FedoraException {

diff --git a/src/main/java/org/fcrepo/migration/idmappers/SimpleIDMapper.java b/src/main/java/org/fcrepo/migration/idmappers/SimpleIDMapper.java
@@ -24,6 +24,7 @@ public class SimpleIDMapper implements MigrationIDMapper {
 
     /**
      * simple ID mapper.
+     * @param baseUrl the base url for the server
      * @param rootPath the root path
      */
     public SimpleIDMapper(final String baseUrl, final String rootPath) {
@@ -50,6 +51,7 @@ public void setCharDepth(final int charDepth) {
     /**
      * Gets the number of characters to use per level when converting
      * a pid to a path.
+     * @return number of characters per level
      */
     public int getCharDepth() {
         return this.charDepth;