Package org.eclipse.jdt.core.dom

Class TypePattern

java.lang.Object

org.eclipse.jdt.core.dom.ASTNode

org.eclipse.jdt.core.dom.Expression

org.eclipse.jdt.core.dom.Pattern

org.eclipse.jdt.core.dom.TypePattern

public class TypePattern
extends Pattern

TypePattern pattern AST node type.

 TypePattern:
      VariableDeclaration
 

Since:

3.27

Restriction:

This class is not intended to be instantiated by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChildPropertyDescriptor	PATTERN_VARIABLE_PROPERTY	Deprecated. In the JLS22 API, this property is replaced by VariableDeclaration.
static final ChildPropertyDescriptor	PATTERN_VARIABLE_PROPERTY2	The "patternVariable" structural property of this node type (child type: VariableDeclaration).

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CASE_DEFAULT_EXPRESSION, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EitherOr_MultiPattern, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, GUARDED_PATTERN, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, JAVADOC_REGION, JAVADOC_TEXT_ELEMENT, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, MODULE_QUALIFIED_NAME, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NULL_PATTERN, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, PATTERN_INSTANCEOF_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECORD_PATTERN, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TAG_PROPERTY, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, TYPE_PATTERN, UNION_TYPE, UNNAMED_CLASS, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT

Method Summary

Modifier and Type	Method	Description
SingleVariableDeclaration	getPatternVariable()	Returns the pattern variable of Types Pattern.
VariableDeclaration	getPatternVariable2()	Returns the pattern variable of Types Pattern.
static List	propertyDescriptors(int apiLevel)	Returns a list of structural property descriptors for this node type.
static List	propertyDescriptors(int apiLevel, boolean previewEnabled)	Returns a list of structural property descriptors for this node type.
void	setPatternVariable(SingleVariableDeclaration patternVariable)	Deprecated, for removal: This API element is subject to removal in a future version. In the JLS22 API, this method is replaced by setPatternVariable(VariableDeclaration patternVariable)
void	setPatternVariable(VariableDeclaration patternVariable2)	Sets the pattern variable.

Methods inherited from class org.eclipse.jdt.core.dom.Expression

resolveBoxing, resolveConstantExpressionValue, resolveTypeBinding, resolveUnboxing

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

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

Field Details

PATTERN_VARIABLE_PROPERTY

public static final ChildPropertyDescriptor PATTERN_VARIABLE_PROPERTY

Deprecated.

In the JLS22 API, this property is replaced by VariableDeclaration.

The "patternVariable" structural property of this node type (child type: SingleVariableDeclaration).

PATTERN_VARIABLE_PROPERTY2

public static final ChildPropertyDescriptor PATTERN_VARIABLE_PROPERTY2

The "patternVariable" structural property of this node type (child type: VariableDeclaration).

Since:

3.39

Method Details

propertyDescriptors

public static List propertyDescriptors(int apiLevel)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:

apiLevel - the API level; one of the AST.JLS* constants

Returns:

a list of property descriptors (element type: StructuralPropertyDescriptor)

Since:

3.38

propertyDescriptors

public static List propertyDescriptors(int apiLevel,
 boolean previewEnabled)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:

apiLevel - the API level; one of the AST.JLS* constants

previewEnabled - the previewEnabled flag

Returns:

a list of property descriptors (element type: StructuralPropertyDescriptor)

Since:

3.38

setPatternVariable

@Deprecated(forRemoval=true,
            since="2025-03")
public void setPatternVariable(SingleVariableDeclaration patternVariable)

Deprecated, for removal: This API element is subject to removal in a future version.

In the JLS22 API, this method is replaced by setPatternVariable(VariableDeclaration patternVariable)

Sets the pattern variable.

Parameters:

patternVariable - the right operand node

Throws:

IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent
• a cycle in would be created

UnsupportedOperationException - if this operation is used other than JLS19

UnsupportedOperationException - if this expression is used with previewEnabled flag as false

Since:

3.38

setPatternVariable

public void setPatternVariable(VariableDeclaration patternVariable2)

Sets the pattern variable. Supports JLS22 and higher versions

Parameters:

patternVariable2 - the right operand node

Throws:

IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent
• a cycle in would be created

UnsupportedOperationException - if this operation is used other than JLS22

UnsupportedOperationException - if this expression is used with previewEnabled flag as false

Since:

3.39

getPatternVariable

public SingleVariableDeclaration getPatternVariable()

Returns the pattern variable of Types Pattern.

Returns:

the pattern variable

Throws:

UnsupportedOperationException - if this operation is used other than JLS19

UnsupportedOperationException - if this expression is used with previewEnabled flag as false In the JLS22 API, this method is replaced by getPatternVariable2()

Since:

3.38

getPatternVariable2

public VariableDeclaration getPatternVariable2()

Returns the pattern variable of Types Pattern.

Returns:

the pattern variable

Throws:

UnsupportedOperationException - if this operation is used other than JLS22

UnsupportedOperationException - if this expression is used with previewEnabled flag as false

Since:

3.39