Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ReferenceParser.Mode Context dependent parsing mode which either disallows, allows or requires a member reference.
public static class	ReferenceParser.ParseException An exception that indicates an error occurred while parsing a signature.
public static class	ReferenceParser.Reference An object to contain the result of parsing a reference to an API element.
pack-priv static class	ReferenceParser.TypeAnnotationFinder

Modifier and Type	Field and Description
private final ParserFactory	fac

Access	Constructor and Description
public	ReferenceParser(ParserFactory a factory for parsing Java source code. fac) Create a parser object to parse reference signatures.

Method Summary

Modifier and Type	Method and Description
private void	checkDiags(Log.DeferredDiagnosticHandler h, int offset)
public ReferenceParser.Reference	Returns: a `Reference` object containing the result of parsing the signature parse(String the signature to be parsed sig, ReferenceParser.Mode the parsing mode mode) Parse a reference to an API element as may be found in doc comment.
private Name	parseMember(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh)
private JCTree.JCExpression	parseModule(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh)
private List<JCTree>	parseParams(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh)
private JCTree	parseType(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

fac	back to summary
private final ParserFactory fac

ReferenceParser	back to summary
public ReferenceParser(ParserFactory fac) Create a parser object to parse reference signatures. Parameters fac:ParserFactory a factory for parsing Java source code.

Method Detail

checkDiags	back to summary
private void checkDiags(Log.DeferredDiagnosticHandler h, int offset) throws ParseException

parse back to summary

parse	back to summary
public ReferenceParser.Reference parse(String sig, ReferenceParser.Mode mode) throws ParseException Parse a reference to an API element as may be found in doc comment. Parameters sig:String the signature to be parsed mode:ReferenceParser.Mode the parsing mode Returns:ReferenceParser.Reference a `Reference` object containing the result of parsing the signature Exceptions ParseException: if there is an error while parsing the signature

public ReferenceParser.Reference parse(String sig, ReferenceParser.Mode mode) throws ParseException

Parse a reference to an API element as may be found in doc comment.

Parameters

sig:String: the signature to be parsed
mode:ReferenceParser.Mode: the parsing mode

Returns:ReferenceParser.Reference

a Reference object containing the result of parsing the signature

Exceptions

ParseException:: if there is an error while parsing the signature

parseMember	back to summary
private Name parseMember(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh) throws ParseException

parseModule	back to summary
private JCTree.JCExpression parseModule(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh) throws ParseException

parseParams	back to summary
private List<JCTree> parseParams(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh) throws ParseException

parseType	back to summary
private JCTree parseType(String sig, int beginIndex, int endIndex, Log.DeferredDiagnosticHandler dh) throws ParseException

com.sun.tools.javac.parser back to summary

public final Enum ReferenceParser.Mode

Class Inheritance

extends Enum<ReferenceParser.Mode>

java.lang.Object
java.lang.Enum
com.sun.tools.javac.parser.ReferenceParser.Mode

Context dependent parsing mode which either disallows, allows or requires a member reference. The MEMBER_OPTIONAL value also allows arbitrary URI fragments using a double hash mark.

Field Summary

Modifier and Type	Field and Description
public static final ReferenceParser.Mode	MEMBER_DISALLOWED
public static final ReferenceParser.Mode	MEMBER_OPTIONAL
public static final ReferenceParser.Mode	MEMBER_REQUIRED

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

Modifier and Type	Method and Description
public static ReferenceParser.Mode	valueOf(String name)
public static ReferenceParser.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

MEMBER_DISALLOWED	back to summary
public static final ReferenceParser.Mode MEMBER_DISALLOWED

MEMBER_OPTIONAL	back to summary
public static final ReferenceParser.Mode MEMBER_OPTIONAL

MEMBER_REQUIRED	back to summary
public static final ReferenceParser.Mode MEMBER_REQUIRED

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

valueOf	back to summary
public static ReferenceParser.Mode valueOf(String name)

values	back to summary
public static ReferenceParser.Mode[] values()

com.sun.tools.javac.parser back to summary

public Class ReferenceParser.ParseException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.sun.tools.javac.parser.ReferenceParser.ParseException

An exception that indicates an error occurred while parsing a signature.

Field Summary

Modifier and Type	Field and Description
pack-priv final int	pos
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	ParseException(int pos, String message)

Field Detail

pos	back to summary
pack-priv final int pos

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

ParseException	back to summary
pack-priv ParseException(int pos, String message)

com.sun.tools.javac.parser back to summary

public Class ReferenceParser.Reference

Class Inheritance

extends Object

java.lang.Object
com.sun.tools.javac.parser.ReferenceParser.Reference

An object to contain the result of parsing a reference to an API element. Any, but not all, of the member fields may be null.

Field Summary

Modifier and Type	Field and Description
public final Name	member The member name, if any, in the signature.
public final JCTree.JCExpression	moduleName
public final List<JCTree>	paramTypes The parameter types, if any, in the signature.
public final JCTree	qualExpr The type, if any, in the signature.

Constructor Summary

Access	Constructor and Description
pack-priv	Reference(JCTree.JCExpression moduleName, JCTree qualExpr, Name member, List<JCTree> paramTypes)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

member	back to summary
public final Name member The member name, if any, in the signature.

moduleName	back to summary
public final JCTree.JCExpression moduleName

paramTypes	back to summary
public final List<JCTree> paramTypes The parameter types, if any, in the signature.

qualExpr	back to summary
public final JCTree qualExpr The type, if any, in the signature.

Constructor Detail

Reference	back to summary
pack-priv Reference(JCTree.JCExpression moduleName, JCTree qualExpr, Name member, List<JCTree> paramTypes)

com.sun.tools.javac.parser back to summary

pack-priv Class ReferenceParser.TypeAnnotationFinder

Class Inheritance

extends TreeScanner<Tree, Void>

java.lang.Object
com.sun.source.util.TreeScanner
com.sun.tools.javac.parser.ReferenceParser.TypeAnnotationFinder

Constructor Summary

Access	Constructor and Description
pack-priv	TypeAnnotationFinder()

Method Summary

Modifier and Type	Method and Description
public Tree	reduce(Tree t1, Tree t2) Overrides com.sun.source.util.TreeScanner.reduce. Reduces two results into a combined result.
public Tree	visitAnnotatedType(AnnotatedTypeTree t, Void ignore) Overrides com.sun.source.util.TreeScanner.visitAnnotatedType. Implements com.sun.source.tree.TreeVisitor.visitAnnotatedType. Visits an `AnnotatedTypeTree` node.

Inherited from com.sun.source.util.TreeScanner:: scan scan visitAnnotation visitAnyPattern visitArrayAccess visitArrayType visitAssert visitAssignment visitBinary visitBindingPattern visitBlock visitBreak visitCase visitCatch visitClass visitCompilationUnit visitCompoundAssignment visitConditionalExpression visitConstantCaseLabel visitContinue visitDeconstructionPattern visitDefaultCaseLabel visitDoWhileLoop visitEmptyStatement visitEnhancedForLoop visitErroneous visitExports visitExpressionStatement visitForLoop visitIdentifier visitIf visitImport visitInstanceOf visitIntersectionType visitLabeledStatement visitLambdaExpression visitLiteral visitMemberReference visitMemberSelect visitMethod visitMethodInvocation visitModifiers visitModule visitNewArray visitNewClass visitOpens visitOther visitPackage visitParameterizedType visitParenthesized visitPatternCaseLabel visitPrimitiveType visitProvides visitRequires visitReturn visitSwitch visitSwitchExpression visitSynchronized visitThrow visitTry visitTypeCast visitTypeParameter visitUnary visitUnionType visitUses visitVariable visitVarType visitWhileLoop visitWildcard visitYield

Constructor Detail

TypeAnnotationFinder	back to summary
pack-priv TypeAnnotationFinder()

Method Detail

reduce	back to summary
public Tree reduce(Tree t1, Tree t2) Overrides com.sun.source.util.TreeScanner.reduce. Doc from com.sun.source.util.TreeScanner.reduce. Reduces two results into a combined result. The default implementation is to return the first parameter. The general contract of the method is that it may take any action whatsoever. Annotations @Override

reduce

back to summary

public Tree reduce(Tree t1, Tree t2)

Overrides com.sun.source.util.TreeScanner.reduce.

Doc from com.sun.source.util.TreeScanner.reduce.

Reduces two results into a combined result. The default implementation is to return the first parameter. The general contract of the method is that it may take any action whatsoever.

Annotations

@Override

visitAnnotatedType back to summary

visitAnnotatedType	back to summary
public Tree visitAnnotatedType(AnnotatedTypeTree t, Void ignore) Overrides com.sun.source.util.TreeScanner.visitAnnotatedType. Implements com.sun.source.tree.TreeVisitor.visitAnnotatedType. Doc from com.sun.source.util.TreeScanner.visitAnnotatedType. Visits an `AnnotatedTypeTree` node. Annotations @Override

public Tree visitAnnotatedType(AnnotatedTypeTree t, Void ignore)

Overrides com.sun.source.util.TreeScanner.visitAnnotatedType.

Implements com.sun.source.tree.TreeVisitor.visitAnnotatedType.

Doc from com.sun.source.util.TreeScanner.visitAnnotatedType.

Visits an AnnotatedTypeTree node.

Annotations

@Override