Skip to content
Permalink
Browse files

Correct some JavaDoc links that were going to the wrong place.

  • Loading branch information
mikehearn authored and archiecobbs committed Feb 10, 2020
1 parent 658e15b commit ea7d0a74ad0f5ad682bfef2ca52d76c9c1339b04
@@ -120,7 +120,7 @@ public boolean isCopied(ObjId id) {

/**
* Determine whether to suppress {@link io.permazen.annotation.OnCreate @OnCreate} and
* {@link io.permazen.annotation.OnCreate @OnChange} notifications in the destination transaction.
* {@link io.permazen.annotation.OnChange @OnChange} notifications in the destination transaction.
*
* <p>
* Note that for notifications to be delivered in a {@link SnapshotJTransaction}, these annotations must
@@ -130,22 +130,22 @@ public boolean isCopied(ObjId id) {
* Default is false.
*
* @return true if {@link io.permazen.annotation.OnCreate &#64;OnCreate} and
* {@link io.permazen.annotation.OnCreate &#64;OnChange} notifications should be suppressed, otherwise false
* {@link io.permazen.annotation.OnChange &#64;OnChange} notifications should be suppressed, otherwise false
*/
public boolean isSuppressNotifications() {
return this.suppressNotifications;
}

/**
* Configure whether to suppress {@link io.permazen.annotation.OnCreate &#64;OnCreate} and
* {@link io.permazen.annotation.OnCreate &#64;OnChange} notifications in the destination transaction.
* {@link io.permazen.annotation.OnChange &#64;OnChange} notifications in the destination transaction.
*
* <p>
* Note that for notifications to be delivered in a {@link SnapshotJTransaction}, these annotations must
* also have {@code snapshotTransactions = true}, even if this property is set to false.
*
* @param suppressNotifications true if {@link io.permazen.annotation.OnCreate &#64;OnCreate} and
* {@link io.permazen.annotation.OnCreate &#64;OnChange} notifications should be suppressed, otherwise false
* {@link io.permazen.annotation.OnChange &#64;OnChange} notifications should be suppressed, otherwise false
*/
public void setSuppressNotifications(boolean suppressNotifications) {
this.suppressNotifications = suppressNotifications;
@@ -188,10 +188,10 @@ default boolean upgrade() {
* <p>
* This instance will first be {@link #upgrade}ed if necessary. If any copied object already exists in {@code dest},
* it will have its schema version updated first, if necessary, then be overwritten.
* Any {@link io.permazen.annotation.OnCreate &#64;OnVersionChange}, {@link io.permazen.annotation.OnCreate &#64;OnCreate},
* and {@link io.permazen.annotation.OnCreate &#64;OnChange} methods will be notified accordingly as usual (in {@code dest});
* Any {@link io.permazen.annotation.OnVersionChange &#64;OnVersionChange}, {@link io.permazen.annotation.OnCreate &#64;OnCreate},
* and {@link io.permazen.annotation.OnChange &#64;OnChange} methods will be notified accordingly as usual (in {@code dest});
* however, for {@link io.permazen.annotation.OnCreate &#64;OnCreate} and
* {@link io.permazen.annotation.OnCreate &#64;OnChange}, the annotation must have {@code snapshotTransactions = true}
* {@link io.permazen.annotation.OnChange &#64;OnChange}, the annotation must have {@code snapshotTransactions = true}
* if {@code dest} is a {@link SnapshotJTransaction}.
*
* <p>
@@ -335,10 +335,10 @@ default JObject cascadeCopyTo(JTransaction dest, String cascadeName, boolean clo
* <p>
* This instance will first be {@link #upgrade}ed if necessary. If any copied object already exists in {@code dest},
* it will have its schema version updated first, if necessary, then be overwritten.
* Any {@link io.permazen.annotation.OnCreate &#64;OnVersionChange}, {@link io.permazen.annotation.OnCreate &#64;OnCreate},
* and {@link io.permazen.annotation.OnCreate &#64;OnChange} methods will be notified accordingly as usual (in {@code dest});
* Any {@link io.permazen.annotation.OnVersionChange &#64;OnVersionChange}, {@link io.permazen.annotation.OnCreate &#64;OnCreate},
* and {@link io.permazen.annotation.OnChange &#64;OnChange} methods will be notified accordingly as usual (in {@code dest});
* however, for {@link io.permazen.annotation.OnCreate &#64;OnCreate} and
* {@link io.permazen.annotation.OnCreate &#64;OnChange}, the annotation must have {@code snapshotTransactions = true}
* {@link io.permazen.annotation.OnChange &#64;OnChange}, the annotation must have {@code snapshotTransactions = true}
* if {@code dest} is a {@link SnapshotJTransaction}.
*
* <p>
@@ -504,7 +504,7 @@ public SnapshotJTransaction createSnapshotTransaction(ValidationMode validationM
* If the target object does not exist, it will be created, otherwise its schema version will be updated to match the source
* object if necessary (with resulting {@link io.permazen.annotation.OnVersionChange &#64;OnVersionChange} notifications).
* If {@link CopyState#isSuppressNotifications()} returns false, {@link io.permazen.annotation.OnCreate &#64;OnCreate}
* and {@link io.permazen.annotation.OnCreate &#64;OnChange} notifications will also be delivered; however,
* and {@link io.permazen.annotation.OnChange &#64;OnChange} notifications will also be delivered; however,
* these annotations must also have {@code snapshotTransactions = true} if {@code dest} is a {@link SnapshotJTransaction}).
*
* <p>
@@ -649,7 +649,7 @@ public void copyTo(JTransaction dest, CopyState copyState, ObjIdSet ids) {
* If a target object does not exist, it will be created, otherwise its schema version will be updated to match the source
* object if necessary (with resulting {@link io.permazen.annotation.OnVersionChange &#64;OnVersionChange} notifications).
* If {@link CopyState#isSuppressNotifications()} returns false, {@link io.permazen.annotation.OnCreate &#64;OnCreate}
* and {@link io.permazen.annotation.OnCreate &#64;OnChange} notifications will also be delivered; however,
* and {@link io.permazen.annotation.OnChange &#64;OnChange} notifications will also be delivered; however,
* these annotations must also have {@code snapshotTransactions = true} if {@code dest} is a {@link SnapshotJTransaction}).
*
* <p>

0 comments on commit ea7d0a7

Please sign in to comment.
You can’t perform that action at this time.