com.github.javaparser.ast.type

Class ArrayType

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.type.Type<T>

com.github.javaparser.ast.type.ReferenceType<ArrayType>

com.github.javaparser.ast.type.ArrayType

All Implemented Interfaces:

NodeWithAnnotations<ArrayType>, Observable, Visitable, HasParentNode<Node>, Cloneable

public class ArrayType
extends ReferenceType<ArrayType>
implements NodeWithAnnotations<ArrayType>

To indicate that a type is an array, it gets wrapped in an ArrayType for every array level it has. So, int[][] becomes ArrayType(ArrayType(int)).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrayType.ArrayBracketPair Helper class that stores information about a pair of brackets.

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.ObserverRegistrationMode

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

Constructor Summary

Constructors

Constructor and Description
ArrayType(Range range, Type<?> componentType, NodeList<AnnotationExpr> annotations)
ArrayType(Type<?> type, AnnotationExpr... annotations)
ArrayType(Type<?> componentType, NodeList<AnnotationExpr> annotations)

Method Summary

Modifier and Type	Method and 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.
Type	getComponentType()
ArrayType	setComponentType(Type<?> type)
static Pair<Type<?>,List<ArrayType.ArrayBracketPair>>	unwrapArrayTypes(Type<?> type) Takes a type that may be an ArrayType.
static Type	wrapInArrayTypes(Type type, List<ArrayType.ArrayBracketPair>... arrayBracketPairLists) Takes lists of arrayBracketPairs, assumes the lists are ordered left to right and the pairs are ordered left to right, mirroring the actual code.

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

getAnnotation, getAnnotations, getElementType, setAnnotations

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, clone, containsWithin, equals, getAllContainedComments, getBegin, getChildNodes, getComment, getData, getEnd, getNodeLists, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getRange, hasComment, hashCode, isPositionedAfter, isPositionedBefore, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setRange, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from class java.lang.Object

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

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

addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, getAnnotations, isAnnotationPresent, isAnnotationPresent, setAnnotations

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Constructor Detail

ArrayType

public ArrayType(Type<?> componentType,
                 NodeList<AnnotationExpr> annotations)

ArrayType

public ArrayType(Type<?> type,
                 AnnotationExpr... annotations)

ArrayType

public ArrayType(Range range,
                 Type<?> componentType,
                 NodeList<AnnotationExpr> annotations)

Method Detail

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)

getComponentType

public Type getComponentType()

setComponentType

public ArrayType setComponentType(Type<?> type)

wrapInArrayTypes

@SafeVarargs
public static Type wrapInArrayTypes(Type type,
                                                 List<ArrayType.ArrayBracketPair>... arrayBracketPairLists)

Takes lists of arrayBracketPairs, assumes the lists are ordered left to right and the pairs are ordered left to right, mirroring the actual code. The type gets wrapped in ArrayTypes so that the outermost ArrayType corresponds to the rightmost ArrayBracketPair.

unwrapArrayTypes

public static Pair<Type<?>,List<ArrayType.ArrayBracketPair>> unwrapArrayTypes(Type<?> type)

Takes a type that may be an ArrayType. Unwraps ArrayTypes until the element type is found.

Returns:

a pair of the element type, and the unwrapped ArrayTypes, if any.