forgetest1
/
antlr
forked from jasder/antlr
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

Add @NotNull annotations to listener and visitor methods

This commit is contained in:
Sam Harwell 2013-05-20 14:20:54 -05:00
parent d6c3841b0a
commit 13f121a16f
3 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/Java/src/org/antlr/v4/runtime/tree/AbstractParseTreeVisitor.java
View File

@ -40,7 +40,7 @@ public abstract class AbstractParseTreeVisitor<T> implements ParseTreeVisitor<T>
* specified tree. * specified tree.
*/ */
@Override @Override
public T visit(ParseTree tree) { public T visit(@NotNull ParseTree tree) {
return tree.accept(this); return tree.accept(this);
} }
@ -56,7 +56,7 @@ public abstract class AbstractParseTreeVisitor<T> implements ParseTreeVisitor<T>
* previous aggregate result and the result of visiting the child. * previous aggregate result and the result of visiting the child.
*/ */
@Override @Override
public T visitChildren(RuleNode node) { public T visitChildren(@NotNull RuleNode node) {
T result = defaultResult(); T result = defaultResult();
int n = node.getChildCount(); int n = node.getChildCount();
for (int i=0; i<n; i++) { for (int i=0; i<n; i++) {
@ -79,7 +79,7 @@ public abstract class AbstractParseTreeVisitor<T> implements ParseTreeVisitor<T>
* {@link #defaultResult defaultResult}. * {@link #defaultResult defaultResult}.
*/ */
@Override @Override
public T visitTerminal(TerminalNode node) { public T visitTerminal(@NotNull TerminalNode node) {
return defaultResult(); return defaultResult();
} }
@ -90,7 +90,7 @@ public abstract class AbstractParseTreeVisitor<T> implements ParseTreeVisitor<T>
* {@link #defaultResult defaultResult}. * {@link #defaultResult defaultResult}.
*/ */
@Override @Override
public T visitErrorNode(ErrorNode node) { public T visitErrorNode(@NotNull ErrorNode node) {
return defaultResult(); return defaultResult();
} }

9
runtime/Java/src/org/antlr/v4/runtime/tree/ParseTreeListener.java
View File

@ -31,10 +31,11 @@
package org.antlr.v4.runtime.tree; package org.antlr.v4.runtime.tree;
import org.antlr.v4.runtime.ParserRuleContext; import org.antlr.v4.runtime.ParserRuleContext;
import org.antlr.v4.runtime.misc.NotNull;
public interface ParseTreeListener { public interface ParseTreeListener {
void visitTerminal(TerminalNode node); void visitTerminal(@NotNull TerminalNode node);
void visitErrorNode(ErrorNode node); void visitErrorNode(@NotNull ErrorNode node);
void enterEveryRule(ParserRuleContext ctx); void enterEveryRule(@NotNull ParserRuleContext ctx);
void exitEveryRule(ParserRuleContext ctx); void exitEveryRule(@NotNull ParserRuleContext ctx);
} }

24
tool/resources/org/antlr/v4/tool/templates/codegen/Java/Java.stg
View File

@ -66,6 +66,7 @@ ListenerFile(file, header) ::= <<
package <file.genPackage>; package <file.genPackage>;
<endif> <endif>
<header> <header>
import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.tree.ParseTreeListener; import org.antlr.v4.runtime.tree.ParseTreeListener;
/** /**
@ -78,12 +79,12 @@ public interface <file.grammarName>Listener extends ParseTreeListener {
* Enter a parse tree produced by {@link <file.parserName>#<lname>\}. * Enter a parse tree produced by {@link <file.parserName>#<lname>\}.
* @param ctx the parse tree * @param ctx the parse tree
*/ */
void enter<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx); void enter<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx);
/** /**
* Exit a parse tree produced by {@link <file.parserName>#<lname>\}. * Exit a parse tree produced by {@link <file.parserName>#<lname>\}.
* @param ctx the parse tree * @param ctx the parse tree
*/ */
void exit<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx);}; separator="\n"> void exit<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx);}; separator="\n">
} }
>> >>
@ -95,6 +96,7 @@ package <file.genPackage>;
<header> <header>
import org.antlr.v4.runtime.ParserRuleContext; import org.antlr.v4.runtime.ParserRuleContext;
import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.tree.ErrorNode; import org.antlr.v4.runtime.tree.ErrorNode;
import org.antlr.v4.runtime.tree.TerminalNode; import org.antlr.v4.runtime.tree.TerminalNode;
@ -110,38 +112,38 @@ public class <file.grammarName>BaseListener implements <file.grammarName>Listene
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void enter<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx) { \} @Override public void enter<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx) { \}
/** /**
* {@inheritDoc\} * {@inheritDoc\}
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void exit<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx) { \}}; separator="\n"> @Override public void exit<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx) { \}}; separator="\n">
/** /**
* {@inheritDoc\} * {@inheritDoc\}
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void enterEveryRule(ParserRuleContext ctx) { } @Override public void enterEveryRule(@NotNull ParserRuleContext ctx) { }
/** /**
* {@inheritDoc\} * {@inheritDoc\}
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void exitEveryRule(ParserRuleContext ctx) { } @Override public void exitEveryRule(@NotNull ParserRuleContext ctx) { }
/** /**
* {@inheritDoc\} * {@inheritDoc\}
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void visitTerminal(TerminalNode node) { } @Override public void visitTerminal(@NotNull TerminalNode node) { }
/** /**
* {@inheritDoc\} * {@inheritDoc\}
* \<p/> * \<p/>
* The default implementation does nothing. * The default implementation does nothing.
*/ */
@Override public void visitErrorNode(ErrorNode node) { } @Override public void visitErrorNode(@NotNull ErrorNode node) { }
} }
>> >>
@ -151,6 +153,7 @@ VisitorFile(file, header) ::= <<
package <file.genPackage>; package <file.genPackage>;
<endif> <endif>
<header> <header>
import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.tree.ParseTreeVisitor; import org.antlr.v4.runtime.tree.ParseTreeVisitor;
/** /**
@ -167,7 +170,7 @@ public interface <file.grammarName>Visitor\<T> extends ParseTreeVisitor\<T> {
* @param ctx the parse tree * @param ctx the parse tree
* @return the visitor result * @return the visitor result
*/ */
T visit<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx);}; separator="\n"> T visit<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx);}; separator="\n">
} }
>> >>
@ -177,6 +180,7 @@ BaseVisitorFile(file, header) ::= <<
package <file.genPackage>; package <file.genPackage>;
<endif> <endif>
<header> <header>
import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.tree.AbstractParseTreeVisitor; import org.antlr.v4.runtime.tree.AbstractParseTreeVisitor;
/** /**
@ -195,7 +199,7 @@ public class <file.grammarName>BaseVisitor\<T> extends AbstractParseTreeVisitor\
* The default implementation returns the result of calling * The default implementation returns the result of calling
* {@link #visitChildren\} on {@code ctx\}. * {@link #visitChildren\} on {@code ctx\}.
*/ */
@Override public T visit<lname; format="cap">(<file.parserName>.<lname; format="cap">Context ctx) { return visitChildren(ctx); \}}; separator="\n"> @Override public T visit<lname; format="cap">(@NotNull <file.parserName>.<lname; format="cap">Context ctx) { return visitChildren(ctx); \}}; separator="\n">
} }
>> >>