Package com.github.javaparser.ast.expr

Class ComponentPatternExpr

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.expr.Expression

com.github.javaparser.ast.expr.ComponentPatternExpr

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Cloneable

Direct Known Subclasses:

MatchAllPatternExpr, PatternExpr

public abstract class ComponentPatternExpr
extends Expression

Pattern Matching in Java

Java 1.0 to 13

Not available.

Java 14

Java 14 introduced TypePatterns with simple pattern matching in instanceof expressions.

Author:

Johannes Coetzee

See Also:

• Java 21

  In Java 21, support for pattern matching was extended to switch expressions and Record Patterns were introduced. Since Record Patterns and TypePatterns can be used interchangeably, the PatternExpr class is used as a common parent for both in the JavaParser AST.

  Java22

  Java 22 added support for match-all pattern expressions that do not have types and cannot be used as top-level patterns. This required a change to the pattern representation in JavaParser. Following the naming convention and structure of the JLS, ComponentPatternExpr is now the base class for all pattern expressions. A ComponentPatternExpr can either be a MatchAllPatternExpr, or a PatternExpr. PatternExpr can then be either a TypePatternExpr or a RecordPatternExpr.

  JDK22 Grammar

  
  

  Pattern:
       TypePattern
       RecordPattern
   TypePattern:
       LocalVariableDeclaration
   RecordPattern:
       ReferenceType ( [ComponentPatternList] )
   ComponentPatternList:
       ComponentPattern {, ComponentPattern }
   ComponentPattern:
       Pattern
       MatchAllPattern
   MatchAllPattern:
       _

• 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 com.github.javaparser.ast.Node

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

Field Summary

Fields inherited from class com.github.javaparser.ast.expr.Expression

EXCLUDE_ENCLOSED_EXPR, IS_NOT_ENCLOSED_EXPR

Fields inherited from class com.github.javaparser.ast.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
ComponentPatternExpr()
ComponentPatternExpr(TokenRange tokenRange)	This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method	Description
ComponentPatternExpr	asComponentPatternExpr()
ComponentPatternExpr	clone()
ComponentPatternExprMetaModel	getMetaModel()
void	ifComponentPatternExpr(Consumer<ComponentPatternExpr> action)
boolean	isComponentPatternExpr()
Optional<ComponentPatternExpr>	toComponentPatternExpr()

Methods inherited from class com.github.javaparser.ast.expr.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, asPatternExpr, asRecordPatternExpr, asSingleMemberAnnotationExpr, asStringLiteralExpr, asSuperExpr, asSwitchExpr, asTextBlockLiteralExpr, asThisExpr, asTypeExpr, asTypePatternExpr, 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, ifPatternExpr, ifRecordPatternExpr, ifSingleMemberAnnotationExpr, ifStringLiteralExpr, ifSuperExpr, ifSwitchExpr, ifTextBlockLiteralExpr, ifThisExpr, ifTypeExpr, ifTypePatternExpr, 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, isPatternExpr, isPolyExpression, isQualified, isRecordPatternExpr, isSingleMemberAnnotationExpr, isStandaloneExpression, isStringLiteralExpr, isSuperExpr, isSwitchExpr, isTextBlockLiteralExpr, isThisExpr, isTypeExpr, isTypePatternExpr, 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, toPatternExpr, toRecordPatternExpr, toSingleMemberAnnotationExpr, toStringLiteralExpr, toSuperExpr, toSwitchExpr, toTextBlockLiteralExpr, toThisExpr, toTypeExpr, toTypePatternExpr, toUnaryExpr, toVariableDeclarationExpr

Methods inherited from class com.github.javaparser.ast.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, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface com.github.javaparser.ast.visitor.Visitable

accept, accept

Constructor Details

ComponentPatternExpr

public ComponentPatternExpr()

ComponentPatternExpr

public ComponentPatternExpr(TokenRange tokenRange)

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

Method Details

isComponentPatternExpr

public boolean isComponentPatternExpr()

Overrides:

isComponentPatternExpr in class Expression

asComponentPatternExpr

public ComponentPatternExpr asComponentPatternExpr()

Overrides:

asComponentPatternExpr in class Expression

toComponentPatternExpr

public Optional<ComponentPatternExpr> toComponentPatternExpr()

Overrides:

toComponentPatternExpr in class Expression

ifComponentPatternExpr

public void ifComponentPatternExpr(Consumer<ComponentPatternExpr> action)

Overrides:

ifComponentPatternExpr in class Expression

clone

public ComponentPatternExpr clone()

Overrides:

clone in class Expression

getMetaModel

public ComponentPatternExprMetaModel getMetaModel()

Overrides:

getMetaModel in class Expression

Returns:

get JavaParser specific node introspection information.