Some minor changes

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / compiler / ast / ArrayDeclarator.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/ArrayDeclarator.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/ArrayDeclarator.java
index ceb04d5..53e5b62 100644 (file)
--- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/ArrayDeclarator.java
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/compiler/ast/ArrayDeclarator.java
@@ -3,19 +3,29 @@ package net.sourceforge.phpdt.internal.compiler.ast;
 import java.util.List;
 
 /**
+ * An access to a key of an array.
  * @author Matthieu Casanova
  */
-public class ArrayDeclarator extends AbstractVariable {
+public final class ArrayDeclarator extends AbstractVariable {
 
-  public AbstractVariable prefix;
-  public Expression var;
+  /** The name of the array. */
+  private final AbstractVariable prefix;
 
+  /** The key. */
+  private final Expression key;
+
+  /**
+   * Create an ArrayDeclarator.
+   * @param prefix the prefix, it could be a variable.
+   * @param key the key
+   * @param sourceEnd the end of the expression
+   */
   public ArrayDeclarator(final AbstractVariable prefix,
-                         final Expression vars,
+                         final Expression key,
                          final int sourceEnd) {
     super(prefix.sourceStart, sourceEnd);
     this.prefix = prefix;
-    this.var = vars;
+    this.key = key;
   }
 
   /**
@@ -25,8 +35,8 @@ public class ArrayDeclarator extends AbstractVariable {
   public String toStringExpression() {
     final StringBuffer buff = new StringBuffer(prefix.toStringExpression());
     buff.append('[');
-    if (var != null) {
-      buff.append(var.toStringExpression());
+    if (key != null) {
+      buff.append(key.toStringExpression());
     }
     buff.append(']');
     return buff.toString();
@@ -42,27 +52,29 @@ public class ArrayDeclarator extends AbstractVariable {
 
   /**
    * Get the variables from outside (parameters, globals ...)
+   * @param list the list where we will put variables
    */
-  public void getOutsideVariable(final List list) {
-  }
+  public void getOutsideVariable(final List list) {}
 
   /**
    * get the modified variables.
+   * @param list the list where we will put variables
    */
   public void getModifiedVariable(final List list) {
     prefix.getModifiedVariable(list);
-    if (var != null) {
-      var.getModifiedVariable(list);
+    if (key != null) {
+      key.getModifiedVariable(list);
     }
   }
 
   /**
    * Get the variables used.
+   * @param list the list where we will put variables
    */
   public void getUsedVariable(final List list) {
     prefix.getUsedVariable(list);
-    if (var != null) {
-      var.getUsedVariable(list);
+    if (key != null) {
+      key.getUsedVariable(list);
     }
   }
 }