Correct -kernel and -kernel-impl Javadoc links to removed Fedora classes

https://jira.duraspace.org/browse/FCREPO-1263
fcrepo · Jan 22, 2015 · 4bf47ae · 4bf47ae
1 parent e10c4fd
commit 4bf47ae
Show file tree

Hide file tree

Showing 17 changed files with 26 additions and 74 deletions.
diff --git a/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/ContainerImpl.java b/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/ContainerImpl.java
@@ -35,7 +35,7 @@ public class ContainerImpl extends FedoraResourceImpl implements Container {
     private static final Logger LOGGER = getLogger(Container.class);
 
     /**
-     * Construct a FedoraObject from an existing JCR Node
+     * Construct a {@link org.fcrepo.kernel.models.Container} from an existing JCR Node
      * @param node an existing JCR node to treat as an fcrepo object
      */
     public ContainerImpl(final Node node) {

diff --git a/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/FedoraResourceImpl.java b/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/FedoraResourceImpl.java
@@ -77,7 +77,8 @@
 import com.hp.hpl.jena.update.UpdateRequest;
 
 /**
- * Common behaviors across FedoraObject and Datastream types; also used
+ * Common behaviors across {@link org.fcrepo.kernel.models.Container} and
+ * {@link org.fcrepo.kernel.models.NonRdfSourceDescription} types; also used
  * when the exact type of an object is irrelevant
  *
  * @author ajs6f
@@ -89,7 +90,7 @@ public class FedoraResourceImpl extends JcrTools implements FedoraJcrTypes, Fedo
     protected Node node;
 
     /**
-     * Construct a FedoraObject from an existing JCR Node
+     * Construct a {@link org.fcrepo.kernel.models.FedoraResource} from an existing JCR Node
      * @param node an existing JCR node to treat as an fcrepo object
      */
     public FedoraResourceImpl(final Node node) {

diff --git a/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/TombstoneImpl.java b/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/TombstoneImpl.java
@@ -33,7 +33,7 @@ public class TombstoneImpl extends FedoraResourceImpl implements Tombstone {
     private static final Logger LOGGER = getLogger(TombstoneImpl.class);
 
     /**
-     * Construct a FedoraObject from an existing JCR Node
+     * Construct a {@link org.fcrepo.kernel.models.FedoraResource} from an existing JCR Node
      * @param node an existing JCR node to treat as an fcrepo object
      */
     public TombstoneImpl(final Node node) {

diff --git a/...po-kernel-impl/src/main/java/org/fcrepo/kernel/impl/observer/GetNamespacedProperties.java b/...po-kernel-impl/src/main/java/org/fcrepo/kernel/impl/observer/GetNamespacedProperties.java
@@ -28,7 +28,7 @@
 
 /**
  * @author Andrew Woods
- *         Date: 11/22/14
+ * @since 11/22/14
  */
 public class GetNamespacedProperties implements Function<FedoraEvent, FedoraEvent> {
 

diff --git a/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/services/ContainerServiceImpl.java b/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/services/ContainerServiceImpl.java
@@ -36,7 +36,7 @@
 import org.springframework.stereotype.Component;
 
 /**
- * Service for creating and retrieving FedoraObjects without using the JCR API.
+ * Service for creating and retrieving {@link org.fcrepo.kernel.models.Container} without using the JCR API.
  *
  * @author cbeer
  * @author ajs6f
@@ -50,8 +50,7 @@ public class ContainerServiceImpl extends AbstractService implements ContainerSe
     /**
      * @param path
      * @param session
-     * @return A FedoraObject with the proffered PID
-     * @throws RepositoryException
+     * @return A {@link org.fcrepo.kernel.models.Container} with the proffered PID
      */
     @Override
     public Container findOrCreate(final Session session, final String path) {
@@ -71,11 +70,10 @@ public Container findOrCreate(final Session session, final String path) {
     }
 
     /**
-     * Retrieve a FedoraObject instance by pid and dsid
+     * Retrieve a {@link org.fcrepo.kernel.models.Container} instance by pid and dsid
      *
      * @param path
-     * @return A FedoraObject with the proffered PID
-     * @throws javax.jcr.RepositoryException
+     * @return A {@link org.fcrepo.kernel.models.Container} with the proffered PID
      */
     @Override
     public Container find(final Session session, final String path) {

diff --git a/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/utils/FedoraTypesUtils.java b/fcrepo-kernel-impl/src/main/java/org/fcrepo/kernel/impl/utils/FedoraTypesUtils.java
@@ -50,14 +50,13 @@ public abstract class FedoraTypesUtils implements FedoraJcrTypes {
     private static final Logger LOGGER = getLogger(FedoraTypesUtils.class);
 
     /**
-     * Predicate for determining whether this {@link Node} is a Fedora object.
+     * Predicate for determining whether this {@link Node} is a {@link org.fcrepo.kernel.models.Container}.
      */
     public static Predicate<Node> isContainer =
             new AnyTypesPredicate(FEDORA_CONTAINER);
 
     /**
-     * Predicate for determining whether this {@link Node} is a Fedora
-     * datastream.
+     * Predicate for determining whether this {@link Node} is a {@link org.fcrepo.kernel.models.NonRdfSourceDescription}
      */
     public static Predicate<Node> isNonRdfSourceDescription =
             new AnyTypesPredicate(FEDORA_NON_RDF_SOURCE_DESCRIPTION);

diff --git a/...ation/kernel/impl/FedoraObjectImplIT.java → ...egration/kernel/impl/ContainerImplIT.java b/...ation/kernel/impl/FedoraObjectImplIT.java → ...egration/kernel/impl/ContainerImplIT.java
@@ -45,13 +45,13 @@
 import org.springframework.test.context.ContextConfiguration;
 
 /**
- * <p>FedoraObjectImplIT class.</p>
+ * <p>{@link ContainerImplIT} class.</p>
  *
  * @author ksclarke
  * @author ajs6f
  */
 @ContextConfiguration({"/spring-test/repo.xml"})
-public class FedoraObjectImplIT extends AbstractIT {
+public class ContainerImplIT extends AbstractIT {
 
     @Inject
     Repository repo;

diff --git a/fcrepo-kernel-impl/src/test/java/org/fcrepo/integration/kernel/impl/DatastreamImplIT.java b/fcrepo-kernel-impl/src/test/java/org/fcrepo/integration/kernel/impl/DatastreamImplIT.java
diff --git a/fcrepo-kernel-impl/src/test/java/org/fcrepo/integration/kernel/impl/FedoraBinaryImplIT.java b/fcrepo-kernel-impl/src/test/java/org/fcrepo/integration/kernel/impl/FedoraBinaryImplIT.java
@@ -58,7 +58,7 @@
 import org.springframework.test.context.ContextConfiguration;
 
 /**
- * <p>DatastreamImplIT class.</p>
+ * <p>{@link org.fcrepo.integration.kernel.impl.FedoraBinaryImplIT} class.</p>
  *
  * @author ksclarke
  * @author ajs6f

diff --git a/...crepo/kernel/impl/DatastreamImplTest.java → ...impl/NonRdfSourceDescriptionImplTest.java b/...crepo/kernel/impl/DatastreamImplTest.java → ...impl/NonRdfSourceDescriptionImplTest.java
@@ -43,12 +43,12 @@
 import static org.mockito.MockitoAnnotations.initMocks;
 
 /**
- * <p>DatastreamImplTest class.</p>
+ * <p>{@link NonRdfSourceDescriptionImplTest} class.</p>
  *
  * @author ksclarke
  * @author ajs6f
  */
-public class DatastreamImplTest implements FedoraJcrTypes {
+public class NonRdfSourceDescriptionImplTest implements FedoraJcrTypes {
 
     private static final String testDsId = "testDs";
 

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/RepositoryRuntimeException.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/RepositoryRuntimeException.java
@@ -16,7 +16,7 @@
 package org.fcrepo.kernel.exception;
 
 /**
- * Runtime exception that wraps a RepositoryException
+ * Runtime exception
  *
  * @author bbpennel
  */

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/ResourceTypeException.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/ResourceTypeException.java
@@ -17,8 +17,8 @@
 package org.fcrepo.kernel.exception;
 
 /**
- * An extension of RepositoryException that may be thrown when attempting a
- * operation (or instantiation) of one fedora resource type (Object, Datastream)
+ * An extension of {@link RepositoryRuntimeException} that may be thrown when attempting a
+ * operation (or instantiation) of a {@link org.fcrepo.kernel.models.FedoraResource}
  * on a different (and incompatible) type.
  *
  * @author Mike Durbin

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/TombstoneException.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/exception/TombstoneException.java
@@ -18,7 +18,8 @@
 import org.fcrepo.kernel.models.FedoraResource;
 
 /**
- * Exception when a Tombstone object is used where a real object is expected
+ * Exception when a Tombstone {@link org.fcrepo.kernel.models.FedoraResource}
+ * is used where a real object is expected
  *
  * @author cabeer
  * @since 10/16/14

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/identifiers/PidMinter.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/identifiers/PidMinter.java
@@ -17,8 +17,7 @@
 
 /**
  * Defines the behavior of a component that can accept responsibility
- * for the creation of Fedora PIDs. Do not implement this interface directly.
- * Subclass BasePidMinter instead.
+ * for the creation of Fedora PIDs.
  *
  * @author eddies
  * @author ajs6f

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/services/ContainerService.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/services/ContainerService.java
@@ -18,7 +18,7 @@
 import org.fcrepo.kernel.models.Container;
 
 /**
- * Service for creating and retrieving FedoraObjects
+ * Service for creating and retrieving {@link org.fcrepo.kernel.models.Container}
  *
  * @author bbpennel
  * @since Feb 20, 2014

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/kernel/services/TransactionService.java b/fcrepo-kernel/src/main/java/org/fcrepo/kernel/services/TransactionService.java
@@ -40,7 +40,7 @@ public interface TransactionService {
     Transaction beginTransaction(Session sess, String userName);
 
     /**
-     * Recieve an open {@link Transaction} for a given user
+     * Receive an open {@link Transaction} for a given user
      *
      * @param txId the Id of the {@link Transaction}
      * @param userName the name  of the {@link java.security.Principal}

diff --git a/...po-kernel/src/main/java/org/fcrepo/kernel/services/policy/StoragePolicyDecisionPoint.java b/...po-kernel/src/main/java/org/fcrepo/kernel/services/policy/StoragePolicyDecisionPoint.java
@@ -20,7 +20,7 @@
 import javax.jcr.Node;
 
 /**
- * Service Interface implementation for managing and using StoragePolicy
+ * Service Interface implementation for managing and using {@link org.fcrepo.kernel.services.policy.StoragePolicy}
  * @author osmandin
  * @since Aug 14, 2013
  *