JavaParser Source Viewer

Home|JavaParser/com/github/javaparser/ast/stmt/YieldStmt.java
1/*
2 * Copyright (C) 2007-2010 Júlio Vilmar Gesser.
3 * Copyright (C) 2011, 2013-2020 The JavaParser Team.
4 *
5 * This file is part of JavaParser.
6 *
7 * JavaParser can be used either under the terms of
8 * a) the GNU Lesser General Public License as published by
9 *     the Free Software Foundation, either version 3 of the License, or
10 *     (at your option) any later version.
11 * b) the terms of the Apache License
12 *
13 * You should have received a copy of both licenses in LICENCE.LGPL and
14 * LICENCE.APACHE. Please refer to those files for details.
15 *
16 * JavaParser is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 */
21package com.github.javaparser.ast.stmt;
22
23import com.github.javaparser.TokenRange;
24import com.github.javaparser.ast.AllFieldsConstructor;
25import com.github.javaparser.ast.Generated;
26import com.github.javaparser.ast.expr.Expression;
27import com.github.javaparser.ast.expr.NameExpr;
28import com.github.javaparser.ast.nodeTypes.NodeWithExpression;
29import com.github.javaparser.ast.observer.ObservableProperty;
30import com.github.javaparser.ast.visitor.GenericVisitor;
31import com.github.javaparser.ast.visitor.VoidVisitor;
32import java.util.Optional;
33import java.util.function.Consumer;
34import com.github.javaparser.ast.Node;
35import com.github.javaparser.ast.visitor.CloneVisitor;
36import com.github.javaparser.metamodel.YieldStmtMetaModel;
37import com.github.javaparser.metamodel.JavaParserMetaModel;
38import static com.github.javaparser.utils.Utils.assertNotNull;
39
40/**
41 * <h1>The yield statement</h1>
42 * <h2>Java 1.0-11</h2>
43 * Does not exist.
44 * <h2>Java 12</h2>
45 * Yields an expression to be used in the switch-expression:
46 * <br>{@code yield 123+456;}
47 * <br>{@code yield "more or less";}
48 */
49public class YieldStmt extends Statement implements NodeWithExpression {
50
51    private Expression expression;
52
53    public YieldStmt() {
54        this(null, new NameExpr());
55    }
56
57    @AllFieldsConstructor
58    public YieldStmt(final Expression expression) {
59        this(null, expression);
60    }
61
62    /**
63     * This constructor is used by the parser and is considered private.
64     */
65    @Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")
66    public YieldStmt(TokenRange tokenRange, Expression expression) {
67        super(tokenRange);
68        setExpression(expression);
69        customInitialization();
70    }
71
72    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
73    public Expression getExpression() {
74        return expression;
75    }
76
77    /**
78     * Sets the label
79     *
80     * @param expression the label or the expression, can be null
81     * @return this, the YieldStmt
82     */
83    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
84    public YieldStmt setExpression(final Expression expression) {
85        assertNotNull(expression);
86        if (expression == this.expression) {
87            return (YieldStmt) this;
88        }
89        notifyPropertyChange(ObservableProperty.EXPRESSION, this.expression, expression);
90        if (this.expression != null)
91            this.expression.setParentNode(null);
92        this.expression = expression;
93        setAsParentNodeOf(expression);
94        return this;
95    }
96
97    @Override
98    @Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
99    public <R, A> R accept(final GenericVisitor<R, A> v, final A arg) {
100        return v.visit(this, arg);
101    }
102
103    @Override
104    @Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
105    public <A> void accept(final VoidVisitor<A> v, final A arg) {
106        v.visit(this, arg);
107    }
108
109    @Override
110    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
111    public boolean isYieldStmt() {
112        return true;
113    }
114
115    @Override
116    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
117    public YieldStmt asYieldStmt() {
118        return this;
119    }
120
121    @Override
122    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
123    public Optional<YieldStmt> toYieldStmt() {
124        return Optional.of(this);
125    }
126
127    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
128    public void ifYieldStmt(Consumer<YieldStmt> action) {
129        action.accept(this);
130    }
131
132    @Override
133    @Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
134    public boolean remove(Node node) {
135        if (node == null)
136            return false;
137        return super.remove(node);
138    }
139
140    @Override
141    @Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
142    public boolean replace(Node node, Node replacementNode) {
143        if (node == null)
144            return false;
145        if (node == expression) {
146            setExpression((Expression) replacementNode);
147            return true;
148        }
149        return super.replace(node, replacementNode);
150    }
151
152    @Override
153    @Generated("com.github.javaparser.generator.core.node.CloneGenerator")
154    public YieldStmt clone() {
155        return (YieldStmt) accept(new CloneVisitor(), null);
156    }
157
158    @Override
159    @Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")
160    public YieldStmtMetaModel getMetaModel() {
161        return JavaParserMetaModel.yieldStmtMetaModel;
162    }
163}
164
MembersX
YieldStmt:accept
YieldStmt:asYieldStmt
YieldStmt:getMetaModel
YieldStmt:setExpression
YieldStmt:replace
YieldStmt:getExpression
YieldStmt:toYieldStmt
YieldStmt:ifYieldStmt
YieldStmt:remove
YieldStmt:isYieldStmt
YieldStmt:expression
YieldStmt:YieldStmt
YieldStmt:clone
Members
X
CodeThinker, Enjoy your reading code