Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ArrayType.ArrayBracketPair Helper class that stores information about a pair of brackets in a non-recursive way (unlike ArrayType.)
public static enum	ArrayType.Origin The origin of a pair of array brackets [].

Modifier and Type	Field and Description
private Type	componentType
private ArrayType.Origin	origin

Constructor Summary

Access	Constructor and Description
public	ArrayType(Type componentType, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations)
public	ArrayType(Type type, AnnotationExpr... annotations)
public	ArrayType(TokenRange tokenRange, Type componentType, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
public <R, A> R	accept(final GenericVisitor<R, A> the visitor implementation v, final A the argument passed to the visitor (of type A) arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support.
public <A> void	accept(final VoidVisitor<A> the visitor implementation v, final A any value relevant for the visitor (of type A) arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support.
public ArrayType	asArrayType() Overrides com.github.javaparser.ast.type.Type.asArrayType.
public String	asString() Implements abstract com.github.javaparser.ast.type.Type.asString.
public ArrayType	clone() Overrides com.github.javaparser.ast.type.ReferenceType.clone. Creates and returns a copy of this object.
public Type	getComponentType()
public ArrayTypeMetaModel	getMetaModel() Overrides com.github.javaparser.ast.type.ReferenceType.getMetaModel.
public ArrayType.Origin	getOrigin()
public void	ifArrayType(Consumer<ArrayType> action) Overrides com.github.javaparser.ast.type.Type.ifArrayType.
public boolean	isArrayType() Overrides com.github.javaparser.ast.type.Type.isArrayType.
public boolean	remove(Node node) Overrides com.github.javaparser.ast.type.ReferenceType.remove.
public boolean	replace(Node node, Node replacementNode) Overrides com.github.javaparser.ast.type.ReferenceType.replace.
public ResolvedArrayType	resolve() Implements abstract com.github.javaparser.ast.type.Type.resolve. Implements com.github.javaparser.resolution.Resolvable.resolve.
public ArrayType	setAnnotations(NodeList<AnnotationExpr> annotations) Overrides com.github.javaparser.ast.type.Type.setAnnotations. Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.
public ArrayType	setComponentType(final Type componentType)
public ArrayType	setOrigin(final ArrayType.Origin origin)
public Optional<ArrayType>	toArrayType() Overrides com.github.javaparser.ast.type.Type.toArrayType.
public static Pair<Type, List<ArrayType.ArrayBracketPair>>	Returns: a pair of the element type, and the unwrapped ArrayTypes, if any. unwrapArrayTypes(Type type) Takes a type that may be an ArrayType.
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.

Inherited from com.github.javaparser.ast.type.ReferenceType:: asReferenceType ifReferenceType isReferenceType toReferenceType

Field Detail

componentType	back to summary
private Type componentType

origin	back to summary
private ArrayType.Origin origin

Constructor Detail

ArrayType	back to summary
public ArrayType(Type componentType, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations) Annotations @AllFieldsConstructor

ArrayType	back to summary
public ArrayType(Type type, AnnotationExpr... annotations)

ArrayType	back to summary
public ArrayType(TokenRange tokenRange, Type componentType, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations) This constructor is used by the parser and is considered private. Annotations @Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

ArrayType

back to summary

public ArrayType(TokenRange tokenRange, Type componentType, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations)

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

Annotations

@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

accept	back to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Doc from com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support. Parameters <R> the type of the return value of the visitor <A> the type the user argument passed to the visitor v:GenericVisitor<R, A> the visitor implementation arg:A the argument passed to the visitor (of type A) Returns:R the result of the visit (of type R) Annotations @Override @Generated:com.github.javaparser.generator.core.node.AcceptGenerator

back to summary

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

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters

<R>: the type of the return value of the visitor
<A>: the type the user argument passed to the visitor
v:GenericVisitor<R, A>: the visitor implementation
arg:A: the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator

accept	back to summary
public <A> void accept(final VoidVisitor<A> v, final A arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Doc from com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support. Parameters <A> the type the argument passed for the visitor v:VoidVisitor<A> the visitor implementation arg:A any value relevant for the visitor (of type A) Annotations @Override @Generated:com.github.javaparser.generator.core.node.AcceptGenerator

back to summary

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

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters

<A>: the type the argument passed for the visitor
v:VoidVisitor<A>: the visitor implementation
arg:A: any value relevant for the visitor (of type A)

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator

asArrayType	back to summary
public ArrayType asArrayType() Overrides com.github.javaparser.ast.type.Type.asArrayType. Annotations @Override @Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

asArrayType

back to summary

public ArrayType asArrayType()

Overrides com.github.javaparser.ast.type.Type.asArrayType.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

asString	back to summary
public String asString() Implements abstract com.github.javaparser.ast.type.Type.asString. Annotations @Override

asString

back to summary

public String asString()

Implements abstract com.github.javaparser.ast.type.Type.asString.

Annotations

@Override

clone back to summary

clone	back to summary
public ArrayType clone() Overrides com.github.javaparser.ast.type.ReferenceType.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:ArrayType a clone of this instance. Annotations @Override @Generated:com.github.javaparser.generator.core.node.CloneGenerator

public ArrayType clone()

Overrides com.github.javaparser.ast.type.ReferenceType.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ArrayType

a clone of this instance.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator

getComponentType	back to summary
public Type getComponentType() Annotations @Generated:com.github.javaparser.generator.core.node.PropertyGenerator

getMetaModel	back to summary
public ArrayTypeMetaModel getMetaModel() Overrides com.github.javaparser.ast.type.ReferenceType.getMetaModel. Returns:ArrayTypeMetaModel Doc from com.github.javaparser.ast.Node.getMetaModel. get JavaParser specific node introspection information. Annotations @Override @Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator

getMetaModel

back to summary

public ArrayTypeMetaModel getMetaModel()

Overrides com.github.javaparser.ast.type.ReferenceType.getMetaModel.

Returns:ArrayTypeMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator

getOrigin	back to summary
public ArrayType.Origin getOrigin() Annotations @Generated:com.github.javaparser.generator.core.node.PropertyGenerator

ifArrayType	back to summary
public void ifArrayType(Consumer<ArrayType> action) Overrides com.github.javaparser.ast.type.Type.ifArrayType. Annotations @Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

ifArrayType

back to summary

public void ifArrayType(Consumer<ArrayType> action)

Overrides com.github.javaparser.ast.type.Type.ifArrayType.

Annotations

@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

isArrayType	back to summary
public boolean isArrayType() Overrides com.github.javaparser.ast.type.Type.isArrayType. Annotations @Override @Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

isArrayType

back to summary

public boolean isArrayType()

Overrides com.github.javaparser.ast.type.Type.isArrayType.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

remove	back to summary
public boolean remove(Node node) Overrides com.github.javaparser.ast.type.ReferenceType.remove. Annotations @Override @Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator

remove

back to summary

public boolean remove(Node node)

Overrides com.github.javaparser.ast.type.ReferenceType.remove.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator

replace	back to summary
public boolean replace(Node node, Node replacementNode) Overrides com.github.javaparser.ast.type.ReferenceType.replace. Annotations @Override @Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator

replace

back to summary

public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.type.ReferenceType.replace.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator

resolve	back to summary
public ResolvedArrayType resolve() Implements abstract com.github.javaparser.ast.type.Type.resolve. Implements com.github.javaparser.resolution.Resolvable.resolve. Annotations @Override

resolve

back to summary

public ResolvedArrayType resolve()

Implements abstract com.github.javaparser.ast.type.Type.resolve.

Implements com.github.javaparser.resolution.Resolvable.resolve.

Annotations

@Override

setAnnotations	back to summary
public ArrayType setAnnotations(NodeList<AnnotationExpr> annotations) Overrides com.github.javaparser.ast.type.Type.setAnnotations. Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations. Annotations @Override

setAnnotations

back to summary

public ArrayType setAnnotations(NodeList<AnnotationExpr> annotations)

Overrides com.github.javaparser.ast.type.Type.setAnnotations.

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

Annotations

@Override

setComponentType	back to summary
public ArrayType setComponentType(final Type componentType) Annotations @Generated:com.github.javaparser.generator.core.node.PropertyGenerator

setOrigin	back to summary
public ArrayType setOrigin(final ArrayType.Origin origin) Annotations @Generated:com.github.javaparser.generator.core.node.PropertyGenerator

toArrayType	back to summary
public Optional<ArrayType> toArrayType() Overrides com.github.javaparser.ast.type.Type.toArrayType. Annotations @Override @Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

toArrayType

back to summary

public Optional<ArrayType> toArrayType()

Overrides com.github.javaparser.ast.type.Type.toArrayType.

Annotations

@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator

unwrapArrayTypes	back to summary
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:Pair<Type, List<ArrayType.ArrayBracketPair>> a pair of the element type, and the unwrapped ArrayTypes, if any.

unwrapArrayTypes

back to summary

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:Pair<Type, List<ArrayType.ArrayBracketPair>>: a pair of the element type, and the unwrapped ArrayTypes, if any.

wrapInArrayTypes	back to summary
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. Annotations @SafeVarargs

wrapInArrayTypes

back to summary

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.

Annotations

@SafeVarargs

com.github.javaparser.ast.type back to summary

public Class ArrayType.ArrayBracketPair

Class Inheritance

extends Object

java.lang.Object
com.github.javaparser.ast.type.ArrayType.ArrayBracketPair

Helper class that stores information about a pair of brackets in a non-recursive way (unlike ArrayType.)

Field Summary

Modifier and Type	Field and Description
private NodeList<AnnotationExpr>	annotations
private ArrayType.Origin	origin
private TokenRange	tokenRange

Constructor Summary

Access	Constructor and Description
public	ArrayBracketPair(TokenRange tokenRange, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations)

Method Summary

Modifier and Type	Method and Description
public NodeList<AnnotationExpr>	getAnnotations()
public ArrayType.Origin	getOrigin()
public Optional<TokenRange>	getTokenRange()
public ArrayType.ArrayBracketPair	setAnnotations(NodeList<AnnotationExpr> annotations)
public ArrayType.ArrayBracketPair	setOrigin(ArrayType.Origin origin)
public ArrayType.ArrayBracketPair	setTokenRange(TokenRange range)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotations	back to summary
private NodeList<AnnotationExpr> annotations

origin	back to summary
private ArrayType.Origin origin

tokenRange	back to summary
private TokenRange tokenRange

Constructor Detail

ArrayBracketPair	back to summary
public ArrayBracketPair(TokenRange tokenRange, ArrayType.Origin origin, NodeList<AnnotationExpr> annotations)

Method Detail

getAnnotations	back to summary
public NodeList<AnnotationExpr> getAnnotations()

getOrigin	back to summary
public ArrayType.Origin getOrigin()

getTokenRange	back to summary
public Optional<TokenRange> getTokenRange()

setAnnotations	back to summary
public ArrayType.ArrayBracketPair setAnnotations(NodeList<AnnotationExpr> annotations)

setOrigin	back to summary
public ArrayType.ArrayBracketPair setOrigin(ArrayType.Origin origin)

setTokenRange	back to summary
public ArrayType.ArrayBracketPair setTokenRange(TokenRange range)

com.github.javaparser.ast.type back to summary

public final Enum ArrayType.Origin

Class Inheritance

extends Enum<ArrayType.Origin>

java.lang.Object
java.lang.Enum
com.github.javaparser.ast.type.ArrayType.Origin

The origin of a pair of array brackets [].

Field Summary

Modifier and Type	Field and Description
public static final ArrayType.Origin	NAME The [] were found on the name, like "int a[]" or "String abc()[][]"
public static final ArrayType.Origin	TYPE The [] were found on the type, like "int[] a" or "String[][] abc()"

Constructor Summary

Access	Constructor and Description
private	Origin()

Method Summary

Modifier and Type	Method and Description
public static ArrayType.Origin	valueOf(String name)
public static ArrayType.Origin[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NAME	back to summary
public static final ArrayType.Origin NAME The [] were found on the name, like "int a[]" or "String abc()[][]"

TYPE	back to summary
public static final ArrayType.Origin TYPE The [] were found on the type, like "int[] a" or "String[][] abc()"

Constructor Detail

Origin	back to summary
private Origin()

Method Detail

valueOf	back to summary
public static ArrayType.Origin valueOf(String name)

values	back to summary
public static ArrayType.Origin[] values()