Added Javadocs

fcrepo · Feb 26, 2013 · 13b5a8f · 13b5a8f
1 parent d6ad261
commit 13b5a8f
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/FedoraObject.java b/fcrepo-kernel/src/main/java/org/fcrepo/FedoraObject.java
@@ -15,6 +15,13 @@
 
 import org.modeshape.jcr.api.JcrTools;
 
+/**
+ * An abstraction that represents a Fedora Object backed by
+ * a JCR node.
+ * 
+ * @author ajs6f
+ *
+ */
 public class FedoraObject extends JcrTools {
 
     private Node node;
@@ -35,10 +42,17 @@ public FedoraObject(Session session, String path)
                 node.getName()});
     }
 
+    /**
+     * @return The JCR name of the node that backs this object.
+     * @throws RepositoryException
+     */
     public String getName() throws RepositoryException {
         return node.getName();
     }
 
+    /**
+     * @return The JCR node that backs this object.
+     */
     public Node getNode() {
         return node;
     }

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/services/ObjectService.java b/fcrepo-kernel/src/main/java/org/fcrepo/services/ObjectService.java
@@ -82,7 +82,7 @@ public static Node getObjectNode(final String pid)
 
     /**
      * @param pid
-     * @return A FedoraObject with the proferred PID
+     * @return A FedoraObject with the proffered PID
      * @throws RepositoryException
      */
     public static FedoraObject getObject(final String pid)

diff --git a/fcrepo-kernel/src/main/java/org/fcrepo/utils/FedoraJcrTypes.java b/fcrepo-kernel/src/main/java/org/fcrepo/utils/FedoraJcrTypes.java
@@ -1,6 +1,12 @@
 
 package org.fcrepo.utils;
 
+/**
+ * Convenience class with constants for commonly used JCR types.
+ * 
+ * @author ajs6f
+ *
+ */
 public class FedoraJcrTypes {
 
     public static final String FEDORA_DATASTREAM = "fedora:datastream";