spmallette commented on code in PR #3157:
URL: https://github.com/apache/tinkerpop/pull/3157#discussion_r2251363853
##########
gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/TraversalStrategy.java:
##########
@@ -31,21 +33,37 @@
import java.util.Set;
/**
- * A {@link TraversalStrategy} defines a particular atomic operation for
mutating a {@link Traversal} prior to its evaluation.
- * There are 5 pre-defined "traversal categories": {@link DecorationStrategy},
{@link OptimizationStrategy}, {@link ProviderOptimizationStrategy}, {@link
FinalizationStrategy}, and {@link VerificationStrategy}.
- * Strategies within a category are sorted amongst themselves and then
category sorts are applied in the ordered specified previous.
- * That is, decorations are applied, then optimizations, then provider
optimizations, then finalizations, and finally, verifications.
- * If a strategy does not fit within the specified categories, then it can
simply implement {@link TraversalStrategy} and can have priors/posts that span
categories.
+ * A {@link TraversalStrategy} defines a particular atomic operation for
mutating a {@link Traversal} prior to its
+ * evaluation. There are 5 pre-defined "traversal categories": {@link
DecorationStrategy}, {@link OptimizationStrategy},
+ * {@link ProviderOptimizationStrategy}, {@link FinalizationStrategy}, and
{@link VerificationStrategy}.
+ * Strategies within a category are sorted amongst themselves, and then
category sorts are applied in the ordered
+ * specified previously. That is, decorations are applied, then optimizations,
then provider optimizations, then
+ * finalizations, and finally, verifications. If a strategy does not fit
within the specified categories, then it can
+ * simply implement {@link TraversalStrategy} and can have priors/posts that
span categories.
* <p/>
- * A traversal strategy should be a final class as various internal operations
on a strategy are based on its ability to be assigned to more general classes.
- * A traversal strategy should typically be stateless with a public static
<code>instance()</code> method.
- * However, at limit, a traversal strategy can have a state defining
constructor (typically via a "builder"), but that state can not mutate once
instantiated.
+ * A traversal strategy should be a final class as various internal operations
on a strategy are based on its ability to
+ * be assigned to more general classes. A traversal strategy should typically
be stateless with a public static
+ * <code>instance()</code> method. However, at limit, a traversal strategy can
have a state-defining constructor
+ * (typically via a "builder"), but that state cannot mutate once instantiated.
+ * <p/>
+ * Given that a traversal strategy can completely rewrite a traversal, it must
take into account the
Review Comment:
I think this javadoc is not completely accurate anymore and needs update.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
