Class TypePatternExpr

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.expr.Expression

com.github.javaparser.ast.expr.ComponentPatternExpr

com.github.javaparser.ast.expr.PatternExpr

com.github.javaparser.ast.expr.TypePatternExpr

All Implemented Interfaces:

NodeWithFinalModifier<TypePatternExpr>, NodeWithModifiers<TypePatternExpr>, NodeWithRange<Node>, NodeWithSimpleName<TypePatternExpr>, NodeWithTokenRange<Node>, NodeWithType<ComponentPatternExpr, Type>, Observable, Visitable, HasParentNode<Node>, Cloneable

public class TypePatternExpr
extends PatternExpr
implements NodeWithSimpleName<TypePatternExpr>, NodeWithFinalModifier<TypePatternExpr>

The instanceof statement

Java 1.0 to 13

Not available.

Java 14

Since JDK14, it is possible to bind a variable that is cast to the type being tested against. This is referred to as a Pattern within JEP305, and avoids the need to cast to the desired type.
Example:

tool instanceof Drill d
                ^^^^^^^
                Pattern

Note: While this is exclusively used within instanceof operators for now, JEP305 suggests this might be used more widely in the future (e.g. in switch expressions/statements).

JDK14 Grammar

Per JEP305 (not currently listed within the JLS):

Pattern:
     Type Identifier

See Also:

• InstanceOfExpr
• JEP305: https://bugs.openjdk.java.net/browse/JDK-8181287
• https://docs.oracle.com/javase/specs/jls/se11/html/jls-15.html#jls-15.20

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields

Modifier and Type	Field	Description
private NodeList<Modifier>	modifiers
private SimpleName	name

Fields inherited from class Expression

EXCLUDE_ENCLOSED_EXPR, IS_NOT_ENCLOSED_EXPR

Fields inherited from class Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
TypePatternExpr()
TypePatternExpr(NodeList<Modifier> modifiers, Type type, SimpleName name)
TypePatternExpr(TokenRange tokenRange, NodeList<Modifier> modifiers, Type type, SimpleName name)	This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method	Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg)	Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg)	Accept method for visitor support.
TypePatternExpr	asTypePatternExpr()
TypePatternExpr	clone()
TypePatternExprMetaModel	getMetaModel()
NodeList<Modifier>	getModifiers()	Return the modifiers of this variable declaration.
SimpleName	getName()
void	ifTypePatternExpr(Consumer<TypePatternExpr> action)
boolean	isTypePatternExpr()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
TypePatternExpr	setModifiers(NodeList<Modifier> modifiers)
TypePatternExpr	setName(SimpleName name)
Optional<TypePatternExpr>	toTypePatternExpr()

Methods inherited from class PatternExpr

asPatternExpr, getType, ifPatternExpr, isPatternExpr, setType, toPatternExpr

Methods inherited from class ComponentPatternExpr

asComponentPatternExpr, ifComponentPatternExpr, isComponentPatternExpr, toComponentPatternExpr

Methods inherited from class Expression

appearsInAssignmentContext, appearsInInvocationContext, asAnnotationExpr, asArrayAccessExpr, asArrayCreationExpr, asArrayInitializerExpr, asAssignExpr, asBinaryExpr, asBooleanLiteralExpr, asCastExpr, asCharLiteralExpr, asClassExpr, asConditionalExpr, asDoubleLiteralExpr, asEnclosedExpr, asFieldAccessExpr, asInstanceOfExpr, asIntegerLiteralExpr, asLambdaExpr, asLiteralExpr, asLiteralStringValueExpr, asLongLiteralExpr, asMarkerAnnotationExpr, asMatchAllPatternExpr, asMethodCallExpr, asMethodReferenceExpr, asNameExpr, asNormalAnnotationExpr, asNullLiteralExpr, asObjectCreationExpr, asRecordPatternExpr, asSingleMemberAnnotationExpr, asStringLiteralExpr, asSuperExpr, asSwitchExpr, asTextBlockLiteralExpr, asThisExpr, asTypeExpr, asUnaryExpr, asVariableDeclarationExpr, calculateResolvedType, elidesTypeArguments, ifAnnotationExpr, ifArrayAccessExpr, ifArrayCreationExpr, ifArrayInitializerExpr, ifAssignExpr, ifBinaryExpr, ifBooleanLiteralExpr, ifCastExpr, ifCharLiteralExpr, ifClassExpr, ifConditionalExpr, ifDoubleLiteralExpr, ifEnclosedExpr, ifFieldAccessExpr, ifInstanceOfExpr, ifIntegerLiteralExpr, ifLambdaExpr, ifLiteralExpr, ifLiteralStringValueExpr, ifLongLiteralExpr, ifMarkerAnnotationExpr, ifMatchAllPatternExpr, ifMethodCallExpr, ifMethodReferenceExpr, ifNameExpr, ifNormalAnnotationExpr, ifNullLiteralExpr, ifObjectCreationExpr, ifRecordPatternExpr, ifSingleMemberAnnotationExpr, ifStringLiteralExpr, ifSuperExpr, ifSwitchExpr, ifTextBlockLiteralExpr, ifThisExpr, ifTypeExpr, ifUnaryExpr, ifVariableDeclarationExpr, isAnnotationExpr, isArrayAccessExpr, isArrayCreationExpr, isArrayInitializerExpr, isAssignExpr, isAssignmentContext, isBinaryExpr, isBooleanLiteralExpr, isCastExpr, isCharLiteralExpr, isClassExpr, isConditionalExpr, isDoubleLiteralExpr, isEnclosedExpr, isFieldAccessExpr, isInstanceOfExpr, isIntegerLiteralExpr, isInvocationContext, isLambdaExpr, isLiteralExpr, isLiteralStringValueExpr, isLongLiteralExpr, isMarkerAnnotationExpr, isMatchAllPatternExpr, isMethodCallExpr, isMethodReferenceExpr, isNameExpr, isNormalAnnotationExpr, isNullLiteralExpr, isObjectCreationExpr, isPolyExpression, isQualified, isRecordPatternExpr, isSingleMemberAnnotationExpr, isStandaloneExpression, isStringLiteralExpr, isSuperExpr, isSwitchExpr, isTextBlockLiteralExpr, isThisExpr, isTypeExpr, isUnaryExpr, isVariableDeclarationExpr, toAnnotationExpr, toArrayAccessExpr, toArrayCreationExpr, toArrayInitializerExpr, toAssignExpr, toBinaryExpr, toBooleanLiteralExpr, toCastExpr, toCharLiteralExpr, toClassExpr, toConditionalExpr, toDoubleLiteralExpr, toEnclosedExpr, toFieldAccessExpr, toInstanceOfExpr, toIntegerLiteralExpr, toLambdaExpr, toLiteralExpr, toLiteralStringValueExpr, toLongLiteralExpr, toMarkerAnnotationExpr, toMatchAllPatternExpr, toMethodCallExpr, toMethodReferenceExpr, toNameExpr, toNormalAnnotationExpr, toNullLiteralExpr, toObjectCreationExpr, toRecordPatternExpr, toSingleMemberAnnotationExpr, toStringLiteralExpr, toSuperExpr, toSwitchExpr, toTextBlockLiteralExpr, toThisExpr, toTypeExpr, toUnaryExpr, toVariableDeclarationExpr

Methods inherited from class Node

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface NodeWithFinalModifier

isFinal, setFinal

Methods inherited from interface NodeWithModifiers

addModifier, getAccessSpecifier, hasModifier, removeModifier, setModifier, setModifiers

Methods inherited from interface NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface NodeWithSimpleName

getNameAsExpression, getNameAsString, setName

Methods inherited from interface NodeWithType

getTypeAsString, setType, setType, tryAddImportToParentCompilationUnit

Field Details

modifiers

private NodeList<Modifier> modifiers

name

private SimpleName name

Constructor Details

TypePatternExpr

public TypePatternExpr()

TypePatternExpr

public TypePatternExpr(NodeList<Modifier> modifiers,
 Type type,
 SimpleName name)

TypePatternExpr

public TypePatternExpr(TokenRange tokenRange,
 NodeList<Modifier> modifiers,
 Type type,
 SimpleName name)

This constructor is used by the parser and is considered private.

Method Details

accept

public <R,A> R accept(GenericVisitor<R,A> v,
 A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Overrides:

accept in class PatternExpr

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
 A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Overrides:

accept in class PatternExpr

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

getName

public SimpleName getName()

Specified by:

getName in interface NodeWithSimpleName<TypePatternExpr>

setName

public TypePatternExpr setName(SimpleName name)

Specified by:

setName in interface NodeWithSimpleName<TypePatternExpr>

replace

public boolean replace(Node node,
 Node replacementNode)

Overrides:

replace in class PatternExpr

clone

public TypePatternExpr clone()

Overrides:

clone in class PatternExpr

getMetaModel

public TypePatternExprMetaModel getMetaModel()

Overrides:

getMetaModel in class PatternExpr

Returns:

get JavaParser specific node introspection information.

getModifiers

public NodeList<Modifier> getModifiers()

Description copied from interface: NodeWithModifiers

Return the modifiers of this variable declaration. Warning: modifying the returned set will not trigger observers, you have to use setModifiers for that.

Specified by:

getModifiers in interface NodeWithModifiers<TypePatternExpr>

Returns:

modifiers

See Also:

• Modifier

setModifiers

public TypePatternExpr setModifiers(NodeList<Modifier> modifiers)

Specified by:

setModifiers in interface NodeWithModifiers<TypePatternExpr>

remove

public boolean remove(Node node)

Overrides:

remove in class Node

isTypePatternExpr

public boolean isTypePatternExpr()

Overrides:

isTypePatternExpr in class Expression

asTypePatternExpr

public TypePatternExpr asTypePatternExpr()

Overrides:

asTypePatternExpr in class Expression

toTypePatternExpr

public Optional<TypePatternExpr> toTypePatternExpr()

Overrides:

toTypePatternExpr in class Expression

ifTypePatternExpr

public void ifTypePatternExpr(Consumer<TypePatternExpr> action)

Overrides:

ifTypePatternExpr in class Expression