Package com.github.javaparser.ast.type

Class UnionType

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.type.Type

com.github.javaparser.ast.type.UnionType

All Implemented Interfaces:

NodeWithAnnotations<UnionType>, NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, ConvertibleToUsage, Visitable, HasParentNode<Node>, Resolvable<ResolvedType>, Cloneable

public class UnionType
extends Type
implements NodeWithAnnotations<UnionType>

The union type

Represents a set of types. A given value of this type has to be assignable to at least one of the element types.

Java 1-6

Does not exist.

Java 7+

As of Java 7 it is used in catch clauses.

 try {
 ...
 } catch(IOException | NullPointerException ex) {
 ...
 }
 

The types that make up the union type are its "elements"

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.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
UnionType()
UnionType(NodeList<ReferenceType> elements)
UnionType(TokenRange tokenRange, NodeList<ReferenceType> elements)	This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method	Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg)	Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg)	Accept method for visitor support.
String	asString()
UnionType	asUnionType()
UnionType	clone()
ResolvedType	convertToUsage(Context context)
NodeList<ReferenceType>	getElements()
UnionTypeMetaModel	getMetaModel()
void	ifUnionType(Consumer<UnionType> action)
boolean	isUnionType()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ResolvedUnionType	resolve()
UnionType	setAnnotations(NodeList<AnnotationExpr> annotations)
UnionType	setElements(NodeList<ReferenceType> elements)
Optional<UnionType>	toUnionType()

Methods inherited from class com.github.javaparser.ast.type.Type

asArrayType, asClassOrInterfaceType, asIntersectionType, asPrimitiveType, asReferenceType, asTypeParameter, asUnknownType, asVarType, asVoidType, asWildcardType, getAnnotation, getAnnotations, getArrayLevel, getElementType, ifArrayType, ifClassOrInterfaceType, ifIntersectionType, ifPrimitiveType, ifReferenceType, ifTypeParameter, ifUnknownType, ifVarType, ifVoidType, ifWildcardType, isArrayType, isClassOrInterfaceType, isIntersectionType, isPrimitiveType, isReferenceType, isTypeParameter, isUnknownType, isVarType, isVoidType, isWildcardType, toArrayType, toClassOrInterfaceType, toDescriptor, toIntersectionType, toPrimitiveType, toReferenceType, toTypeParameter, toUnknownType, toVarType, toVoidType, toWildcardType

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, removeComment, removeData, removeForced, removeOrphanComment, 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.NodeWithAnnotations

addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, getAnnotations, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

UnionType

public UnionType()

UnionType

public UnionType(TokenRange tokenRange,
                 NodeList<ReferenceType> elements)

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

UnionType

public UnionType(NodeList<ReferenceType> elements)

Method Detail

getElements

public NodeList<ReferenceType> getElements()

setElements

public UnionType setElements(NodeList<ReferenceType> elements)

setAnnotations

public UnionType setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<UnionType>

Overrides:

setAnnotations in class Type

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                            A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

remove

public boolean remove(Node node)

Overrides:

remove in class Type

asString

public String asString()

Specified by:

asString in class Type

clone

public UnionType clone()

Overrides:

clone in class Type

getMetaModel

public UnionTypeMetaModel getMetaModel()

Overrides:

getMetaModel in class Type

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Type

isUnionType

public boolean isUnionType()

Overrides:

isUnionType in class Type

asUnionType

public UnionType asUnionType()

Overrides:

asUnionType in class Type

ifUnionType

public void ifUnionType(Consumer<UnionType> action)

Overrides:

ifUnionType in class Type

resolve

public ResolvedUnionType resolve()

Specified by:

resolve in interface Resolvable<ResolvedType>

Specified by:

resolve in class Type

toUnionType

public Optional<UnionType> toUnionType()

Overrides:

toUnionType in class Type

convertToUsage

public ResolvedType convertToUsage(Context context)

Specified by:

convertToUsage in interface ConvertibleToUsage