X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMField.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMField.java index 72de2a6..2c59e19 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMField.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMField.java @@ -11,66 +11,76 @@ package net.sourceforge.phpdt.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. + * 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. *

*/ 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). - */ -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). - * - * @exception IllegalArgumentException if null is specified - */ -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; + /** + * 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). + */ + 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). + * + * @exception IllegalArgumentException + * if null is specified + */ + 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; }