NO-JIRA Remove javadoc warnings and code warnings from the selector package.
Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/3fb96f27 Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/3fb96f27 Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/3fb96f27 Branch: refs/heads/master Commit: 3fb96f273396e1a25aacf7ac6cdd827e37e52ec7 Parents: c133d59 Author: Timothy Bish <[email protected]> Authored: Thu Oct 8 14:09:26 2015 -0400 Committer: Timothy Bish <[email protected]> Committed: Thu Oct 8 14:09:40 2015 -0400 ---------------------------------------------------------------------- qpid-jms-client/pom.xml | 1 - .../selector/filter/ArithmeticExpression.java | 4 - .../jms/selector/filter/BinaryExpression.java | 4 +- .../selector/filter/ComparisonExpression.java | 13 +- .../qpid/jms/selector/filter/Expression.java | 5 + .../jms/selector/filter/LogicExpression.java | 4 - .../jms/selector/parser/ParseException.java | 313 ++- .../jms/selector/parser/SelectorParserImpl.java | 2457 ++++++++++-------- .../parser/SelectorParserImplTokenManager.java | 1934 +++++++------- .../jms/selector/parser/SimpleCharStream.java | 860 +++--- .../apache/qpid/jms/selector/parser/Token.java | 233 +- .../qpid/jms/selector/parser/TokenMgrError.java | 260 +- 12 files changed, 3056 insertions(+), 3032 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/pom.xml ---------------------------------------------------------------------- diff --git a/qpid-jms-client/pom.xml b/qpid-jms-client/pom.xml index 3914b07..120baaa 100644 --- a/qpid-jms-client/pom.xml +++ b/qpid-jms-client/pom.xml @@ -94,7 +94,6 @@ <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> - <version>${jacoco-plugin-version}</version> <configuration> <excludes> <!-- Generated selector parser --> http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java index 7b8bb03..8538aea 100755 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ArithmeticExpression.java @@ -25,10 +25,6 @@ public abstract class ArithmeticExpression extends BinaryExpression { protected static final int LONG = 2; protected static final int DOUBLE = 3; - /** - * @param left - * @param right - */ public ArithmeticExpression(Expression left, Expression right) { super(left, right); } http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/BinaryExpression.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/BinaryExpression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/BinaryExpression.java index d6c714d..2783ea3 100755 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/BinaryExpression.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/BinaryExpression.java @@ -78,14 +78,14 @@ public abstract class BinaryExpression implements Expression { public abstract String getExpressionSymbol(); /** - * @param expression + * @param expression the RHS. */ public void setRight(Expression expression) { right = expression; } /** - * @param expression + * @param expression the LHS */ public void setLeft(Expression expression) { left = expression; http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ComparisonExpression.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ComparisonExpression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ComparisonExpression.java index c52f288..7495c1f 100755 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ComparisonExpression.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/ComparisonExpression.java @@ -24,14 +24,11 @@ import java.util.regex.Pattern; /** * A filter performing a comparison of two objects */ +@SuppressWarnings({ "rawtypes", "unchecked" }) public abstract class ComparisonExpression extends BinaryExpression implements BooleanExpression { private static final Set<Character> REGEXP_CONTROL_CHARS = new HashSet<Character>(); - /** - * @param left - * @param right - */ public ComparisonExpression(Expression left, Expression right) { super(left, right); } @@ -71,8 +68,6 @@ public abstract class ComparisonExpression extends BinaryExpression implements B Pattern likePattern; - /** - */ public LikeExpression(Expression right, String like, int escape) { super(right); @@ -297,6 +292,7 @@ public abstract class ComparisonExpression extends BinaryExpression implements B * Only Numeric expressions can be used in {@literal >, >=, < or <=} expressions. * * @param expr + * The expression to evaluate. */ public static void checkLessThanOperand(Expression expr) { if (expr instanceof ConstantExpression) { @@ -318,6 +314,7 @@ public abstract class ComparisonExpression extends BinaryExpression implements B * not be NULL TRUE or FALSE literals. * * @param expr + * The expression to evaluate. */ public static void checkEqualOperand(Expression expr) { if (expr instanceof ConstantExpression) { @@ -328,10 +325,6 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } } - /** - * @param left - * @param right - */ private static void checkEqualOperandCompatability(Expression left, Expression right) { if (left instanceof ConstantExpression && right instanceof ConstantExpression) { if (left instanceof BooleanExpression && !(right instanceof BooleanExpression)) { http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/Expression.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/Expression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/Expression.java index 7b69e42..d83fb8d 100755 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/Expression.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/Expression.java @@ -22,7 +22,12 @@ package org.apache.qpid.jms.selector.filter; public interface Expression { /** + * @param message + * The message that is being selected against. + * * @return the value of this expression + * + * @throws FilterException if an error occurs during evaluation. */ Object evaluate(Filterable message) throws FilterException; http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/LogicExpression.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/LogicExpression.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/LogicExpression.java index 1e635e7..4ee208c 100755 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/LogicExpression.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/filter/LogicExpression.java @@ -21,10 +21,6 @@ package org.apache.qpid.jms.selector.filter; */ public abstract class LogicExpression extends BinaryExpression implements BooleanExpression { - /** - * @param left - * @param right - */ public LogicExpression(BooleanExpression left, BooleanExpression right) { super(left, right); } http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/3fb96f27/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/parser/ParseException.java ---------------------------------------------------------------------- diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/parser/ParseException.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/parser/ParseException.java index 3f98bb7..3bf81a5 100644 --- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/parser/ParseException.java +++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/selector/parser/ParseException.java @@ -20,185 +20,172 @@ package org.apache.qpid.jms.selector.parser; /** - * This exception is thrown when parse errors are encountered. - * You can explicitly create objects of this exception type by - * calling the method generateParseException in the generated - * parser. + * This exception is thrown when parse errors are encountered. You can explicitly create objects + * of this exception type by calling the method generateParseException in the generated parser. * - * You can modify this class to customize your error reporting - * mechanisms so long as you retain the public fields. + * You can modify this class to customize your error reporting mechanisms so long as you retain + * the public fields. */ public class ParseException extends Exception { - /** - * The version identifier for this Serializable class. - * Increment only if the <i>serialized</i> form of the - * class changes. - */ - private static final long serialVersionUID = 1L; + /** + * The version identifier for this Serializable class. Increment only if the <i>serialized</i> + * form of the class changes. + */ + private static final long serialVersionUID = 1L; - /** - * This constructor is used by the method "generateParseException" - * in the generated parser. Calling this constructor generates - * a new object of this type with the fields "currentToken", - * "expectedTokenSequences", and "tokenImage" set. - */ - public ParseException(Token currentTokenVal, - int[][] expectedTokenSequencesVal, - String[] tokenImageVal - ) - { - super(initialise(currentTokenVal, expectedTokenSequencesVal, tokenImageVal)); - currentToken = currentTokenVal; - expectedTokenSequences = expectedTokenSequencesVal; - tokenImage = tokenImageVal; - } - - /** - * The following constructors are for use by you for whatever - * purpose you can think of. Constructing the exception in this - * manner makes the exception behave in the normal way - i.e., as - * documented in the class "Throwable". The fields "errorToken", - * "expectedTokenSequences", and "tokenImage" do not contain - * relevant information. The JavaCC generated code does not use - * these constructors. - */ + /** + * This constructor is used by the method "generateParseException" in the generated parser. + * Calling this constructor generates a new object of this type with the fields "currentToken", + * "expectedTokenSequences", and "tokenImage" set. + * + * @param currentTokenVal + * The current token value to set. + * @param expectedTokenSequencesVal + * The expected token sequence value to set. + * @param tokenImageVal + * The token image value to set. + */ + public ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal) { + super(initialise(currentTokenVal, expectedTokenSequencesVal, tokenImageVal)); + currentToken = currentTokenVal; + expectedTokenSequences = expectedTokenSequencesVal; + tokenImage = tokenImageVal; + } - public ParseException() { - super(); - } + /** + * The following constructors are for use by you for whatever purpose you can think of. + * Constructing the exception in this manner makes the exception behave in the normal way - + * i.e., as documented in the class "Throwable". The fields "errorToken", + * "expectedTokenSequences", and "tokenImage" do not contain relevant information. The + * JavaCC generated code does not use these constructors. + */ - /** Constructor with message. */ - public ParseException(String message) { - super(message); - } + public ParseException() { + super(); + } + public ParseException(String message) { + super(message); + } - /** - * This is the last token that has been consumed successfully. If - * this object has been created due to a parse error, the token - * followng this token will (therefore) be the first error token. - */ - public Token currentToken; + /** + * This is the last token that has been consumed successfully. If this object has been created + * due to a parse error, the token following this token will (therefore) be the first error token. + */ + public Token currentToken; - /** - * Each entry in this array is an array of integers. Each array - * of integers represents a sequence of tokens (by their ordinal - * values) that is expected at this point of the parse. - */ - public int[][] expectedTokenSequences; + /** + * Each entry in this array is an array of integers. Each array of integers represents a sequence + * of tokens (by their ordinal values) that is expected at this point of the parse. + */ + public int[][] expectedTokenSequences; - /** - * This is a reference to the "tokenImage" array of the generated - * parser within which the parse error occurred. This array is - * defined in the generated ...Constants interface. - */ - public String[] tokenImage; + /** + * This is a reference to the "tokenImage" array of the generated parser within which the parse + * error occurred. This array is defined in the generated...Constants interface. + */ + public String[] tokenImage; - /** - * It uses "currentToken" and "expectedTokenSequences" to generate a parse - * error message and returns it. If this object has been created - * due to a parse error, and you do not catch it (it gets thrown - * from the parser) the correct error message - * gets displayed. - */ - private static String initialise(Token currentToken, - int[][] expectedTokenSequences, - String[] tokenImage) { - String eol = System.getProperty("line.separator", "\n"); - StringBuffer expected = new StringBuffer(); - int maxSize = 0; - for (int i = 0; i < expectedTokenSequences.length; i++) { - if (maxSize < expectedTokenSequences[i].length) { - maxSize = expectedTokenSequences[i].length; - } - for (int j = 0; j < expectedTokenSequences[i].length; j++) { - expected.append(tokenImage[expectedTokenSequences[i][j]]).append(' '); - } - if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1] != 0) { - expected.append("..."); - } - expected.append(eol).append(" "); - } - String retval = "Encountered \""; - Token tok = currentToken.next; - for (int i = 0; i < maxSize; i++) { - if (i != 0) retval += " "; - if (tok.kind == 0) { - retval += tokenImage[0]; - break; - } - retval += " " + tokenImage[tok.kind]; - retval += " \""; - retval += add_escapes(tok.image); - retval += " \""; - tok = tok.next; - } - retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn; - retval += "." + eol; - if (expectedTokenSequences.length == 1) { - retval += "Was expecting:" + eol + " "; - } else { - retval += "Was expecting one of:" + eol + " "; + /** + * It uses "currentToken" and "expectedTokenSequences" to generate a parse error message and + * returns it. If this object has been created due to a parse error, and you do not catch it + * (it gets thrown from the parser) the correct error message gets displayed. + */ + private static String initialise(Token currentToken, int[][] expectedTokenSequences, String[] tokenImage) { + String eol = System.getProperty("line.separator", "\n"); + StringBuffer expected = new StringBuffer(); + int maxSize = 0; + for (int i = 0; i < expectedTokenSequences.length; i++) { + if (maxSize < expectedTokenSequences[i].length) { + maxSize = expectedTokenSequences[i].length; + } + for (int j = 0; j < expectedTokenSequences[i].length; j++) { + expected.append(tokenImage[expectedTokenSequences[i][j]]).append(' '); + } + if (expectedTokenSequences[i][expectedTokenSequences[i].length - 1] != 0) { + expected.append("..."); + } + expected.append(eol).append(" "); + } + String retval = "Encountered \""; + Token tok = currentToken.next; + for (int i = 0; i < maxSize; i++) { + if (i != 0) + retval += " "; + if (tok.kind == 0) { + retval += tokenImage[0]; + break; + } + retval += " " + tokenImage[tok.kind]; + retval += " \""; + retval += add_escapes(tok.image); + retval += " \""; + tok = tok.next; + } + retval += "\" at line " + currentToken.next.beginLine + ", column " + currentToken.next.beginColumn; + retval += "." + eol; + if (expectedTokenSequences.length == 1) { + retval += "Was expecting:" + eol + " "; + } else { + retval += "Was expecting one of:" + eol + " "; + } + retval += expected.toString(); + return retval; } - retval += expected.toString(); - return retval; - } - /** - * The end of line string for this machine. - */ - protected String eol = System.getProperty("line.separator", "\n"); + /** + * The end of line string for this machine. + */ + protected String eol = System.getProperty("line.separator", "\n"); - /** - * Used to convert raw characters to their escaped version - * when these raw version cannot be used as part of an ASCII - * string literal. - */ - static String add_escapes(String str) { - StringBuffer retval = new StringBuffer(); - char ch; - for (int i = 0; i < str.length(); i++) { - switch (str.charAt(i)) - { - case 0 : - continue; - case '\b': - retval.append("\\b"); - continue; - case '\t': - retval.append("\\t"); - continue; - case '\n': - retval.append("\\n"); - continue; - case '\f': - retval.append("\\f"); - continue; - case '\r': - retval.append("\\r"); - continue; - case '\"': - retval.append("\\\""); - continue; - case '\'': - retval.append("\\\'"); - continue; - case '\\': - retval.append("\\\\"); - continue; - default: - if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) { - String s = "0000" + Integer.toString(ch, 16); - retval.append("\\u" + s.substring(s.length() - 4, s.length())); - } else { - retval.append(ch); - } - continue; + /** + * Used to convert raw characters to their escaped version when these raw version cannot be + * used as part of an ASCII string literal. + */ + static String add_escapes(String str) { + StringBuffer retval = new StringBuffer(); + char ch; + for (int i = 0; i < str.length(); i++) { + switch (str.charAt(i)) { + case 0: + continue; + case '\b': + retval.append("\\b"); + continue; + case '\t': + retval.append("\\t"); + continue; + case '\n': + retval.append("\\n"); + continue; + case '\f': + retval.append("\\f"); + continue; + case '\r': + retval.append("\\r"); + continue; + case '\"': + retval.append("\\\""); + continue; + case '\'': + retval.append("\\\'"); + continue; + case '\\': + retval.append("\\\\"); + continue; + default: + if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) { + String s = "0000" + Integer.toString(ch, 16); + retval.append("\\u" + s.substring(s.length() - 4, s.length())); + } else { + retval.append(ch); + } + continue; + } } - } - return retval.toString(); - } + return retval.toString(); + } } /* JavaCC - OriginalChecksum=3eff901bcee074270b0e9dedf1a477ea (do not edit this line) */ --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
