JavaParser Source Viewer

Home|JavaParser/com/github/javaparser/ast/type/UnionType.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.type;
22
23import com.github.javaparser.ast.AllFieldsConstructor;
24import com.github.javaparser.ast.NodeList;
25import com.github.javaparser.ast.expr.AnnotationExpr;
26import com.github.javaparser.ast.nodeTypes.NodeWithAnnotations;
27import com.github.javaparser.ast.observer.ObservableProperty;
28import com.github.javaparser.ast.visitor.GenericVisitor;
29import com.github.javaparser.ast.visitor.VoidVisitor;
30import static com.github.javaparser.utils.Utils.assertNotNull;
31import static java.util.stream.Collectors.joining;
32import com.github.javaparser.ast.Node;
33import com.github.javaparser.ast.visitor.CloneVisitor;
34import com.github.javaparser.metamodel.NonEmptyProperty;
35import com.github.javaparser.metamodel.UnionTypeMetaModel;
36import com.github.javaparser.metamodel.JavaParserMetaModel;
37import com.github.javaparser.TokenRange;
38import com.github.javaparser.resolution.types.ResolvedUnionType;
39import java.util.function.Consumer;
40import java.util.Optional;
41import com.github.javaparser.ast.Generated;
42
43/**
44 * <h1>The union type</h1>
45 * Represents a set of types. A given value of this type has to be assignable to at least one of the element types.
46 * <h2>Java 1-6</h2>
47 * Does not exist.
48 * <h2>Java 7+</h2>
49 * As of Java 7 it is used in catch clauses.
50 * <pre><code>
51 * try {
52 * ...
53 * } catch(<b>IOException | NullPointerException ex</b>) {
54 * ...
55 * }
56 * </pre>
57 *
58 * The types that make up the union type are its "elements"
59 */
60public class UnionType extends Type implements NodeWithAnnotations<UnionType> {
61
62    @NonEmptyProperty
63    private NodeList<ReferenceType> elements;
64
65    public UnionType() {
66        this(null, new NodeList<>());
67    }
68
69    /**
70     * This constructor is used by the parser and is considered private.
71     */
72    @Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")
73    public UnionType(TokenRange tokenRange, NodeList<ReferenceType> elements) {
74        super(tokenRange);
75        setElements(elements);
76        customInitialization();
77    }
78
79    @AllFieldsConstructor
80    public UnionType(NodeList<ReferenceType> elements) {
81        this(null, elements);
82    }
83
84    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
85    public NodeList<ReferenceType> getElements() {
86        return elements;
87    }
88
89    @Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
90    public UnionType setElements(final NodeList<ReferenceType> elements) {
91        assertNotNull(elements);
92        if (elements == this.elements) {
93            return (UnionType) this;
94        }
95        notifyPropertyChange(ObservableProperty.ELEMENTS, this.elements, elements);
96        if (this.elements != null)
97            this.elements.setParentNode(null);
98        this.elements = elements;
99        setAsParentNodeOf(elements);
100        return this;
101    }
102
103    @Override
104    public UnionType setAnnotations(NodeList<AnnotationExpr> annotations) {
105        return (UnionType) super.setAnnotations(annotations);
106    }
107
108    @Override
109    @Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
110    public <R, A> R accept(final GenericVisitor<R, A> v, final A arg) {
111        return v.visit(this, arg);
112    }
113
114    @Override
115    @Generated("com.github.javaparser.generator.core.node.AcceptGenerator")
116    public <A> void accept(final VoidVisitor<A> v, final A arg) {
117        v.visit(this, arg);
118    }
119
120    @Override
121    @Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
122    public boolean remove(Node node) {
123        if (node == null)
124            return false;
125        for (int i = 0; i < elements.size(); i++) {
126            if (elements.get(i) == node) {
127                elements.remove(i);
128                return true;
129            }
130        }
131        return super.remove(node);
132    }
133
134    @Override
135    public String asString() {
136        return elements.stream().map(Type::asString).collect(joining("|"));
137    }
138
139    @Override
140    @Generated("com.github.javaparser.generator.core.node.CloneGenerator")
141    public UnionType clone() {
142        return (UnionType) accept(new CloneVisitor(), null);
143    }
144
145    @Override
146    @Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")
147    public UnionTypeMetaModel getMetaModel() {
148        return JavaParserMetaModel.unionTypeMetaModel;
149    }
150
151    @Override
152    @Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
153    public boolean replace(Node node, Node replacementNode) {
154        if (node == null)
155            return false;
156        for (int i = 0; i < elements.size(); i++) {
157            if (elements.get(i) == node) {
158                elements.set(i, (ReferenceType) replacementNode);
159                return true;
160            }
161        }
162        return super.replace(node, replacementNode);
163    }
164
165    @Override
166    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
167    public boolean isUnionType() {
168        return true;
169    }
170
171    @Override
172    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
173    public UnionType asUnionType() {
174        return this;
175    }
176
177    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
178    public void ifUnionType(Consumer<UnionType> action) {
179        action.accept(this);
180    }
181
182    @Override
183    public ResolvedUnionType resolve() {
184        return getSymbolResolver().toResolvedType(this, ResolvedUnionType.class);
185    }
186
187    @Override
188    @Generated("com.github.javaparser.generator.core.node.TypeCastingGenerator")
189    public Optional<UnionType> toUnionType() {
190        return Optional.of(this);
191    }
192}
193
MembersX
UnionType:accept
UnionType:clone
UnionType:elements
UnionType:UnionType
UnionType:getMetaModel
UnionType:toUnionType
UnionType:asString
UnionType:asUnionType
UnionType:setAnnotations
UnionType:replace
UnionType:isUnionType
UnionType:setElements
UnionType:remove
UnionType:ifUnionType
UnionType:resolve
UnionType:getElements
Members
X
CodeThinker, Enjoy your reading code