net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/jdom/IDOMInitializer.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core.jdom;
  12
  13 /**
  14  * Represents an initializer. The corresponding syntactic
  15  * units are InstanceInitializer (JLS2 8.6) and StaticDeclaration (JLS2 8.7).
  16  * An initializer has no children and its parent is a type.
  17  * <p>
  18  * This interface is not intended to be implemented by clients.
  19  * </p>
  20  */
  21 public interface IDOMInitializer extends IDOMMember {
  22 /**
  23  * Returns the body of this initializer. The syntax for a body corresponds to
  24  * InstanceInitializer (JLS2 8.6) and StaticDeclaration (JLS2 8.7).
  25  *
  26  * @return an initializer body, including braces, or <code>null</code> if
  27  *   no body is present
  28  */
  29 public String getBody();
  30 /**
  31  * The <code>IDOMInitializer</code> refinement of this <code>IDOMNode</code>
  32  * method returns <code>null</code>. An initializer does not have a name.
  33  */
  34 public String getName();
  35 /**
  36  * Sets the body of this initializer. The syntax for a body corresponds to
  37  * InstanceInitializer (JLS2 8.6) and StaticDeclaration (JLS2 8.7). No formatting
  38  * or syntax checking is performed on the body. Braces <b>must</b> be included.
  39  *
  40  * @param body an initializer body, including braces, or <code>null</code>
  41  *   indicating no body
  42  */
  43 public void setBody(String body);
  44 /**
  45  * The <code>IDOMInitializer</code> refinement of this <code>IDOMNode</code>
  46  * method does nothing.
  47  */
  48 public void setName(String name);
  49 }