org.aspectj.org.eclipse.jdt.core.jdom.IDOMField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation
Show all versions of aspectjtools Show documentation
AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during
compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based
@AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step.
This library is a superset of AspectJ weaver and hence also of AspectJ runtime.
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.aspectj.org.eclipse.jdt.core.jdom;
/**
* Represents a field declaration. The corresponding
* syntactic units are FieldDeclaration (JLS2 8.3) and ConstantDeclaration
* (JLS2 9.3) restricted to a single VariableDeclarator clause.
* A field has no children. The parent of a field is a type.
*
* @deprecated The JDOM was made obsolete by the addition in 2.0 of the more
* powerful, fine-grained DOM/AST API found in the
* org.eclipse.jdt.core.dom package.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IDOMField extends IDOMMember {
/**
* Returns the initializer expression for this field.
* The syntax for an initializer corresponds to VariableInitializer (JLS2 8.3).
*
* Note: The expression does not include a "=".
*
*
* @return the initializer expression, or null if this field does
* not have an initializer
*/
public String getInitializer();
/**
* The IDOMField refinement of this IDOMNode
* method returns the name of this field. The syntax for the name of a field
* corresponds to VariableDeclaratorId (JLS2 8.3).
*
* @return the name of this field
*/
@Override
public String getName();
/**
* Returns the type name of this field. The syntax for a type name of a field
* corresponds to Type in Field Declaration (JLS2 8.3).
*
* @return the type name
*/
public String getType();
/**
* Sets the initializer expression for this field.
* The syntax for an initializer corresponds to VariableInitializer (JLS2 8.3).
*
* Note: The expression does not include a "=".
*
*
* @param initializer the initializer expression, or null indicating
* the field does not have an initializer
*/
public void setInitializer(String initializer);
/**
* The IDOMField refinement of this IDOMNode
* method sets the name of this field. The syntax for the name of a field
* corresponds to VariableDeclaratorId (JLS2 8.3).
*
* @param name the given name
* @exception IllegalArgumentException if null is specified
*/
@Override
public void setName(String name) throws IllegalArgumentException;
/**
* Sets the type name of this field. The syntax for a type name of a field
* corresponds to Type in Field Declaration (JLS2 8.3). Type names must be
* specified as they should appear in source code. For example:
* "String", "int[]", or "java.io.File".
*
* @param typeName the type name
* @exception IllegalArgumentException if null is specified
*/
public void setType(String typeName) throws IllegalArgumentException;
}