Author: jukka
Date: Tue Oct 15 16:38:27 2013
New Revision: 1532418
URL: http://svn.apache.org/r1532418
Log:
OAK-301: Document Oak
Add references in javadoc to more verbose documentation on the site
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitHook.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Editor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorHook.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorProvider.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Validator.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/ValidatorProvider.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitHook.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitHook.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitHook.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/CommitHook.java
Tue Oct 15 16:38:27 2013
@@ -33,6 +33,9 @@ import org.apache.jackrabbit.oak.spi.sta
* Note that instead of implementing this interface directly, most commit
* editors and validators are better expressed as implementations of the
* more specific extension interfaces defined in this package.
+ *
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#The_commit_hook_mechanism";
+ * >The commit hook mechanism</a>
*/
public interface CommitHook {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Editor.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Editor.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Editor.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Editor.java
Tue Oct 15 16:38:27 2013
@@ -33,6 +33,8 @@ import javax.annotation.CheckForNull;
* after state.
*
* @since Oak 0.7
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#Commit_editors";
+ * >Commit editors</a>
*/
public interface Editor {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorHook.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorHook.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorHook.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorHook.java
Tue Oct 15 16:38:27 2013
@@ -30,6 +30,8 @@ import static com.google.common.base.Pre
* passed to the constructor.
*
* @since Oak 0.7
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#Commit_editors";
+ * >Commit editors</a>
*/
public class EditorHook implements CommitHook {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorProvider.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorProvider.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorProvider.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorProvider.java
Tue Oct 15 16:38:27 2013
@@ -28,6 +28,8 @@ import javax.annotation.CheckForNull;
* a single content diff.
*
* @since Oak 0.7
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#Commit_editors";
+ * >Commit editors</a>
*/
public interface EditorProvider {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Validator.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Validator.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Validator.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/Validator.java
Tue Oct 15 16:38:27 2013
@@ -25,6 +25,9 @@ import javax.annotation.CheckForNull;
/**
* Content change validator. An instance of this interface is used to
* validate changes against a specific {@link NodeState}.
+ *
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#Commit_validators";
+ * >Commit validators</a>
*/
public interface Validator extends Editor {
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/ValidatorProvider.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/ValidatorProvider.java?rev=1532418&r1=1532417&r2=1532418&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/ValidatorProvider.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/commit/ValidatorProvider.java
Tue Oct 15 16:38:27 2013
@@ -24,6 +24,9 @@ import javax.annotation.Nonnull;
/**
* Extension point for plugging in different kinds of validation rules
* for content changes.
+ *
+ * @see <a
href="http://jackrabbit.apache.org/oak/docs/nodestate.html#Commit_validators";
+ * >Commit validators</a>
*/
public abstract class ValidatorProvider implements EditorProvider {
