Some minor changes
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / VariableDeclaration.java
index 4adb02d..fc4f236 100644 (file)
@@ -1,15 +1,15 @@
 package net.sourceforge.phpdt.internal.compiler.ast;
 
-import java.util.List;
-
 import net.sourceforge.phpdt.internal.compiler.parser.Outlineable;
 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
-
 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.jface.text.Position;
 
+import java.util.List;
+
 /**
  * A variable declaration.
+ * 
  * @author Matthieu Casanova
  */
 public class VariableDeclaration extends Expression implements Outlineable {
@@ -28,13 +28,13 @@ public class VariableDeclaration extends Expression implements Outlineable {
   public static final int LSHIFT_EQUAL = 11;
   public static final int RSIGNEDSHIFT_EQUAL = 12;
 
-  protected AbstractVariable variable;
+  protected final AbstractVariable variable;
 
   /** The value for variable initialization. */
   public Expression initialization;
 
   private Object parent;
-  private boolean reference;
+  protected boolean reference;
 
   private Position position;
 
@@ -42,10 +42,11 @@ public class VariableDeclaration extends Expression implements Outlineable {
 
   /**
    * Create a variable.
-   * @param variable the name of the variable
+   * 
+   * @param variable       the name of the variable
    * @param initialization the initialization
-   * @param operator the assign operator
-   * @param sourceStart the start point
+   * @param operator       the assign operator
+   * @param sourceStart    the start point
    */
   public VariableDeclaration(final Object parent,
                              final AbstractVariable variable,
@@ -62,7 +63,8 @@ public class VariableDeclaration extends Expression implements Outlineable {
 
   /**
    * Create a variable.
-   * @param variable a variable (in case of $$variablename)
+   * 
+   * @param variable    a variable (in case of $$variablename)
    * @param sourceStart the start point
    */
   public VariableDeclaration(final Object parent,
@@ -75,15 +77,16 @@ public class VariableDeclaration extends Expression implements Outlineable {
     position = new Position(sourceStart, sourceEnd);
   }
 
-  public void setReference(final boolean reference) {
+  public final void setReference(final boolean reference) {
     this.reference = reference;
   }
 
   /**
    * Create a variable.
+   * 
    * @param initialization the initialization
-   * @param variable a variable (in case of $$variablename)
-   * @param sourceStart the start point
+   * @param variable       a variable (in case of $$variablename)
+   * @param sourceStart    the start point
    */
   public VariableDeclaration(final AbstractVariable variable,
                              final Expression initialization,
@@ -97,7 +100,8 @@ public class VariableDeclaration extends Expression implements Outlineable {
 
   /**
    * Create a variable.
-   * @param variable a variable (in case of $$variablename)
+   * 
+   * @param variable    a variable (in case of $$variablename)
    * @param sourceStart the start point
    */
   public VariableDeclaration(final AbstractVariable variable,
@@ -108,9 +112,10 @@ public class VariableDeclaration extends Expression implements Outlineable {
 
   /**
    * Return the operator as String.
+   * 
    * @return the operator
    */
-  public final String operatorToString() {
+  private String operatorToString() {
     switch (operator) {
       case EQUAL:
         return "="; //$NON-NLS-1$
@@ -144,61 +149,67 @@ public class VariableDeclaration extends Expression implements Outlineable {
 
   /**
    * Return the variable into String.
+   * 
    * @return a String
    */
   public String toStringExpression() {
-    final StringBuffer buff;
-    if (reference) {
-      buff = new StringBuffer("&"); //$NON-NLS-1$
+    final String variableString = variable.toStringExpression();
+    if (initialization == null) {
+      if (reference) return '&' + variableString; else return variableString;
     } else {
-      buff = new StringBuffer();//$NON-NLS-1$
-    }
-    buff.append(variable.toStringExpression());
-    if (initialization != null) {
-      buff.append(operatorToString()); //$NON-NLS-1$
-      buff.append(initialization.toStringExpression());
+      final String operatorString = operatorToString();
+      final String initString = initialization.toStringExpression();
+      final StringBuffer buff = new StringBuffer(variableString.length() +
+                                                 operatorString.length() +
+                                                 initString.length() +
+                                                 1);
+      buff.append(variableString);
+      buff.append(operatorString); //$NON-NLS-1$
+      buff.append(initString);
+      return buff.toString();
     }
-    return buff.toString();
   }
 
-  public Object getParent() {
+  public final Object getParent() {
     return parent;
   }
 
-  public String toString() {
+  public final String toString() {
     return toStringExpression();
   }
 
   /**
    * Get the image of a variable.
+   * 
    * @return the image that represents a php variable
    */
-  public ImageDescriptor getImage() {
+  public final ImageDescriptor getImage() {
     return PHPUiImages.DESC_VAR;
   }
 
-  public Position getPosition() {
+  public final Position getPosition() {
     return position;
   }
 
   /**
    * Get the name of the field as String.
+   * 
    * @return the name of the String
    */
-  public String name() {
+  public final String name() {
     return variable.getName();
   }
 
   /**
    * Get the variables from outside (parameters, globals ...)
    */
-  public void getOutsideVariable(final List list) {
+  public final void getOutsideVariable(final List list) {
   }
 
   /**
    * get the modified variables.
    */
-  public void getModifiedVariable(final List list) {
+  public final void getModifiedVariable(final List list) {
     variable.getUsedVariable(list);
     if (initialization != null) {
       initialization.getModifiedVariable(list);
@@ -208,7 +219,7 @@ public class VariableDeclaration extends Expression implements Outlineable {
   /**
    * Get the variables used.
    */
-  public void getUsedVariable(final List list) {
+  public final void getUsedVariable(final List list) {
     if (initialization != null) {
       initialization.getUsedVariable(list);
     }