spoon.reflect.code.CtNewArray Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.reflect.code;

import spoon.reflect.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;

import java.util.List;

import static spoon.reflect.path.CtRole.DIMENSION;
import static spoon.reflect.path.CtRole.EXPRESSION;

/**
 * This code element defines the inline creation of a new array.
 *
 * Example:
 *  *     // inline creation of array content
 *     int[] x = new int[] { 0, 1, 42}
 * 
 * @param 
 * 		type of this array (should be a array...)
 */
public interface CtNewArray extends CtExpression {

	/**
	 * Gets the expressions that define the array's dimensions.
	 */
	@PropertyGetter(role = DIMENSION)
	List> getDimensionExpressions();

	/**
	 * Sets the expressions that define the array's dimensions.
	 */
	@PropertySetter(role = DIMENSION)
	> C setDimensionExpressions(List> dimensions);

	/**
	 * Adds a dimension expression.
	 */
	@PropertySetter(role = DIMENSION)
	> C addDimensionExpression(CtExpression dimension);

	/**
	 * Removes a dimension expression.
	 */
	@PropertySetter(role = DIMENSION)
	boolean removeDimensionExpression(CtExpression dimension);

	/**
	 * Gets the initialization expressions.
	 */
	@PropertyGetter(role = EXPRESSION)
	List> getElements();

	/**
	 * Sets the initialization expressions.
	 */
	@PropertySetter(role = EXPRESSION)
	> C setElements(List> expression);

	/**
	 * Adds an element.
	 */
	@PropertySetter(role = EXPRESSION)
	> C addElement(CtExpression expression);

	/**
	 * Removes an element.
	 */
	@PropertySetter(role = EXPRESSION)
	boolean removeElement(CtExpression expression);

	@Override
	CtNewArray clone();
}