Ate Douma pushed to branch feature/REPO-1920 at cms-community / hippo-repository
Commits:
2536a637 by Ate Douma at 2018-01-15T16:25:21+01:00
REPO-1920 better javadoc
- - - - -
1 changed file:
- api/src/main/java/org/onehippo/repository/update/BaseNodeUpdateVisitor.java
Changes:
=====================================
api/src/main/java/org/onehippo/repository/update/BaseNodeUpdateVisitor.java
=====================================
---
a/api/src/main/java/org/onehippo/repository/update/BaseNodeUpdateVisitor.java
+++
b/api/src/main/java/org/onehippo/repository/update/BaseNodeUpdateVisitor.java
@@ -54,10 +54,10 @@ public abstract class BaseNodeUpdateVisitor implements
NodeUpdateVisitor {
/**
* Overridable boolean function to indicate if node checkout can be
skipped (default false)
- * @return true if node checkout can be skipped
+ * @return true if node checkout can be skipped (e.g. for readonly
visitors and/or updates unrelated to versioned content)
*/
public boolean skipCheckoutNodes() {
- return false; // return true for readonly visitors and/or updates
unrelated to versioned content
+ return false;
}
@Override
@@ -65,23 +65,24 @@ public abstract class BaseNodeUpdateVisitor implements
NodeUpdateVisitor {
}
/**
- * Initiates the retrieval of the nodes when using custom instead of path
or xpath (query) based node selection,
- * returning the first node to visit
+ * Initiates the retrieval of the nodes when using custom, instead of path
or xpath (query) based, node
+ * selection/navigation, returning the first node to visit. Intended to be
overridden, default implementation returns null.
* @param session
* @return first node to visit, or null if none found
* @throws RepositoryException
*/
public Node firstNode(final Session session) throws RepositoryException {
- return null; // implement when using custom node selection/navigation
+ return null;
}
/**
- * Return a following node, when using custom instead of path or xpath
(query) based node selection
+ * Return a following node, when using custom, instead of path or xpath
(query) based, node selection/navigation.
+ * Intended to be overridden, default implementation returns null.
* @return next node to visit, or null if none left
* @throws RepositoryException
*/
public Node nextNode() throws RepositoryException {
- return null; // implement when using custom node selection/navigation
+ return null;
}
@Override
View it on GitLab:
https://code.onehippo.org/cms-community/hippo-repository/commit/2536a637d217b2abee6b9059af4716ee669942ec
---
View it on GitLab:
https://code.onehippo.org/cms-community/hippo-repository/commit/2536a637d217b2abee6b9059af4716ee669942ec
You're receiving this email because of your account on code.onehippo.org.
_______________________________________________
Hippocms-svn mailing list
Hippocms-svn@lists.onehippo.org
https://lists.onehippo.org/mailman/listinfo/hippocms-svn
