com.github.javaparser.ast.expr.PatternExpr Maven / Gradle / Ivy
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2021 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser.ast.expr;
import com.github.javaparser.TokenRange;
import com.github.javaparser.ast.AllFieldsConstructor;
import com.github.javaparser.ast.Generated;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.nodeTypes.NodeWithSimpleName;
import com.github.javaparser.ast.nodeTypes.NodeWithType;
import com.github.javaparser.ast.observer.ObservableProperty;
import com.github.javaparser.ast.type.ClassOrInterfaceType;
import com.github.javaparser.ast.type.ReferenceType;
import com.github.javaparser.ast.visitor.CloneVisitor;
import com.github.javaparser.ast.visitor.GenericVisitor;
import com.github.javaparser.ast.visitor.VoidVisitor;
import com.github.javaparser.metamodel.JavaParserMetaModel;
import com.github.javaparser.metamodel.PatternExprMetaModel;
import java.util.Optional;
import java.util.function.Consumer;
import static com.github.javaparser.utils.Utils.assertNotNull;
/**
* 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 {@code Pattern} within JEP305,
* and avoids the need to cast to the desired type.
*
* Example:
*
* {@code
* tool instanceof Drill d
* ^^^^^^^
* Pattern
* }
*
Note: While this is exclusively used within {@code 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):
*
* {@code Pattern:
* ReferenceType Identifier}
*
* @author Roger Howell
*
* @see com.github.javaparser.ast.expr.InstanceOfExpr
* @see JEP305: https://bugs.openjdk.java.net/browse/JDK-8181287
* @see https://docs.oracle.com/javase/specs/jls/se11/html/jls-15.html#jls-15.20
*/
public class PatternExpr extends Expression implements NodeWithSimpleName, NodeWithType {
private SimpleName name;
private ReferenceType type;
public PatternExpr() {
this(null, new ClassOrInterfaceType(), new SimpleName());
}
@AllFieldsConstructor
public PatternExpr(final ReferenceType type, SimpleName name) {
this(null, type, name);
}
/**
* This constructor is used by the parser and is considered private.
*/
@Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")
public PatternExpr(TokenRange tokenRange, ReferenceType type, SimpleName name) {
super(tokenRange);
setType(type);
setName(name);
customInitialization();
}
@Override
@Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
public R accept(final GenericVisitor v, final A arg) {
return v.visit(this, arg);
}
@Override
@Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
public void accept(final VoidVisitor v, final A arg) {
v.visit(this, arg);
}
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public SimpleName getName() {
return name;
}
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ReferenceType getType() {
return type;
}
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public PatternExpr setName(final SimpleName name) {
assertNotNull(name);
if (name == this.name) {
return this;
}
notifyPropertyChange(ObservableProperty.NAME, this.name, name);
if (this.name != null)
this.name.setParentNode(null);
this.name = name;
setAsParentNodeOf(name);
return this;
}
@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public PatternExpr setType(final ReferenceType type) {
assertNotNull(type);
if (type == this.type) {
return this;
}
notifyPropertyChange(ObservableProperty.TYPE, this.type, type);
if (this.type != null)
this.type.setParentNode(null);
this.type = type;
setAsParentNodeOf(type);
return this;
}
@Override
@Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
public boolean isPatternExpr() {
return true;
}
@Override
@Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
public PatternExpr asPatternExpr() {
return this;
}
@Override
@Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
public Optional toPatternExpr() {
return Optional.of(this);
}
@Override
@Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
public void ifPatternExpr(Consumer action) {
action.accept(this);
}
@Override
@Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public boolean replace(Node node, Node replacementNode) {
if (node == null) {
return false;
}
if (node == name) {
setName((SimpleName) replacementNode);
return true;
}
if (node == type) {
setType((ReferenceType) replacementNode);
return true;
}
return super.replace(node, replacementNode);
}
@Override
@Generated("com.github.javaparser.generator.core.node.CloneGenerator")
public PatternExpr clone() {
return (PatternExpr) accept(new CloneVisitor(), null);
}
@Override
@Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")
public PatternExprMetaModel getMetaModel() {
return JavaParserMetaModel.patternExprMetaModel;
}
}