Eclipse JDT
2.1

org.eclipse.jdt.core.jdom
Interface IDOMField

All Superinterfaces:
Cloneable, IDOMMember, IDOMNode

public interface IDOMField
extends IDOMMember

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.

This interface is not intended to be implemented by clients.


Fields inherited from interface org.eclipse.jdt.core.jdom.IDOMNode
COMPILATION_UNIT, FIELD, IMPORT, INITIALIZER, METHOD, PACKAGE, TYPE
 
Method Summary
 String getInitializer()
          Returns the initializer expression for this field.
 String getName()
          The IDOMField refinement of this IDOMNode method returns the name of this field.
 String getType()
          Returns the type name of this field.
 void setInitializer(String initializer)
          Sets the initializer expression for this field.
 void setName(String name)
          The IDOMField refinement of this IDOMNode method sets the name of this field.
 void setType(String typeName)
          Sets the type name of this field.
 
Methods inherited from interface org.eclipse.jdt.core.jdom.IDOMMember
getComment, getFlags, setComment, setFlags
 
Methods inherited from interface org.eclipse.jdt.core.jdom.IDOMNode
addChild, canHaveChildren, clone, getCharacters, getChild, getChildren, getContents, getFirstChild, getJavaElement, getNextNode, getNodeType, getParent, getPreviousNode, insertSibling, isAllowableChild, isSignatureEqual, remove
 

Method Detail

getInitializer

public String getInitializer()
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 "=".

Returns:
the initializer expression, or null if this field does not have an initializer

getName

public String getName()
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).
Specified by:
getName in interface IDOMNode
Following copied from interface: org.eclipse.jdt.core.jdom.IDOMNode
Returns:
the name, or null if it has no name

getType

public String getType()
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).
Returns:
the type name

setInitializer

public void setInitializer(String initializer)
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 "=".

Parameters:
initializer - the initializer expression, or null indicating the field does not have an initializer

setName

public void setName(String name)
             throws IllegalArgumentException
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).
Specified by:
setName in interface IDOMNode
Throws:
IllegalArgumentException - if null is specified

setType

public void setType(String typeName)
             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".
Parameters:
typeName - the type name
Throws:
IllegalArgumentException - if null is specified

Eclipse JDT
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.