diff options
author | Jon Bratseth <bratseth@oath.com> | 2020-01-10 12:01:35 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-01-10 12:01:35 +0100 |
commit | 82e599d265b0de54a6086a5cf5c586a5c480b915 (patch) | |
tree | d44c32a56212c8ca86614d31dff43dead5f301f4 /document/src | |
parent | 2cedc2133126bf0c4493577b67b76460ee0ced7d (diff) | |
parent | d5d3bb9a0e180ba6ddd4004f877d8b9f25f0ab4f (diff) |
Merge pull request #11742 from vespa-engine/bratseth/nonfunctional-changes
Non-functional changes only
Diffstat (limited to 'document/src')
4 files changed, 23 insertions, 30 deletions
diff --git a/document/src/main/java/com/yahoo/document/DocumentCalculator.java b/document/src/main/java/com/yahoo/document/DocumentCalculator.java index 8fcd3e1acd8..aba400bebf0 100644 --- a/document/src/main/java/com/yahoo/document/DocumentCalculator.java +++ b/document/src/main/java/com/yahoo/document/DocumentCalculator.java @@ -10,7 +10,7 @@ import com.yahoo.document.select.rule.ComparisonNode; import java.util.Map; /** - * @author <a href="mailto:thomasg@yahoo-inc.com">Thomas Gundersen</a> + * @author Thomas Gundersen */ public class DocumentCalculator { @@ -36,4 +36,5 @@ public class DocumentCalculator { throw new IllegalArgumentException("Arithmetic exception " + e.getMessage(), e); } } + } diff --git a/document/src/main/java/com/yahoo/document/select/BucketSelector.java b/document/src/main/java/com/yahoo/document/select/BucketSelector.java index 41a0d9fd87b..b98d9c59657 100644 --- a/document/src/main/java/com/yahoo/document/select/BucketSelector.java +++ b/document/src/main/java/com/yahoo/document/select/BucketSelector.java @@ -39,7 +39,7 @@ public class BucketSelector { * when dealing with unknown bucket sets. * * @param selector The document selection string - * @return A list of buckets with arbitrary number of location bits set, + * @return a list of buckets with arbitrary number of location bits set, * <i>or</i>, <code>null</code> if the document selection resulted * in an unknown set * @throws ParseException if <code>selector</code> couldn't be parsed diff --git a/document/src/main/java/com/yahoo/document/select/DocumentSelector.java b/document/src/main/java/com/yahoo/document/select/DocumentSelector.java index 8b5178d21a8..afda4eec9a9 100644 --- a/document/src/main/java/com/yahoo/document/select/DocumentSelector.java +++ b/document/src/main/java/com/yahoo/document/select/DocumentSelector.java @@ -24,8 +24,8 @@ public class DocumentSelector { /** * Creates a document selector from a Document Selection Language string * - * @param selector The string to parse as a selector. - * @throws ParseException Thrown if the string could not be parsed. + * @param selector the string to parse as a selector + * @throws ParseException Thrown if the string could not be parsed */ public DocumentSelector(String selector) throws ParseException { SelectInput input = new SelectInput(selector); @@ -45,8 +45,8 @@ public class DocumentSelector { /** * Returns true if the document referenced by this document operation is accepted by this selector * - * @param op A document operation - * @return True if the document is accepted. + * @param op a document operation + * @return true if the document is accepted * @throws RuntimeException if the evaluation enters an illegal state */ public Result accepts(DocumentOperation op) { @@ -56,8 +56,8 @@ public class DocumentSelector { /** * Returns true if the document referenced by this context is accepted by this selector * - * @param context The context to match in. - * @return True if the document is accepted. + * @param context the context to match in + * @return true if the document is accepted * @throws RuntimeException if the evaluation enters an illegal state */ public Result accepts(Context context) { @@ -65,11 +65,10 @@ public class DocumentSelector { } /** - * Returns the list of different variables resulting in a true state for this - * expression. + * Returns the list of different variables resulting in a true state for this expression * - * @param op The document to evaluate. - * @return True if the document is accepted. + * @param op the document to evaluate + * @return true if the document is accepted * @throws RuntimeException if the evaluation enters an illegal state */ public ResultList getMatchingResultList(DocumentOperation op) { @@ -77,32 +76,25 @@ public class DocumentSelector { } /** - * Returns the list of different variables resulting in a true state for this - * expression. + * Returns the list of different variables resulting in a true state for this expression * - * @param context The context to match in. - * @return True if the document is accepted. + * @param context the context to match in + * @return true if the document is accepted * @throws RuntimeException if the evaluation enters an illegal state */ private ResultList getMatchingResultList(Context context) { return ResultList.toResultList(expression.evaluate(context)); } - /** - * Returns this selector as a Document Selection Language string. - * - * @return The selection string. - */ + /** Returns this selector as a Document Selection Language string */ + @Override public String toString() { return expression.toString(); } - /** - * Visits the expression tree. - * - * @param visitor The visitor to use. - */ + /** Visits the expression tree */ public void visit(Visitor visitor) { expression.accept(visitor); } + } diff --git a/document/src/main/java/com/yahoo/document/select/rule/ExpressionNode.java b/document/src/main/java/com/yahoo/document/select/rule/ExpressionNode.java index 232262eb466..8b8144ce84a 100644 --- a/document/src/main/java/com/yahoo/document/select/rule/ExpressionNode.java +++ b/document/src/main/java/com/yahoo/document/select/rule/ExpressionNode.java @@ -17,22 +17,22 @@ public interface ExpressionNode { /** * Evaluate the content of this node based on document object, and return that value. * - * @param doc The document to evaluate over. - * @return The value of this. + * @param doc the document to evaluate over. + * @return the value of this. */ Object evaluate(Context doc); /** * Returns the set of bucket ids covered by this node. * - * @param factory The factory used by the current application. + * @param factory the factory used by the current application. */ BucketSet getBucketSet(BucketIdFactory factory); /** * Perform visitation of this node. * - * @param visitor The visitor that wishes to visit the node. + * @param visitor the visitor that wishes to visit the node. */ void accept(Visitor visitor); |