[Mulgara-svn] r602 - branches/mgr-61-sparql/src/jar/query/java/org/mulgara/query

[pag at mulgara.org]

Author: pag
Date: 2007-12-09 14:39:03 -0600 (Sun, 09 Dec 2007)
New Revision: 602

Modified:
   branches/mgr-61-sparql/src/jar/query/java/org/mulgara/query/Variable.java
Log:
Updating formatting

Modified: branches/mgr-61-sparql/src/jar/query/java/org/mulgara/query/Variable.java
===================================================================
--- branches/mgr-61-sparql/src/jar/query/java/org/mulgara/query/Variable.java	2007-12-09 20:35:30 UTC (rev 601)
+++ branches/mgr-61-sparql/src/jar/query/java/org/mulgara/query/Variable.java	2007-12-09 20:39:03 UTC (rev 602)
@@ -34,15 +34,10 @@
  *
  * @author <a href="http://staff.pisoftware.com/raboczi">Simon Raboczi</a>
  *
- * @version $Revision: 1.8 $
+ * @maintenanceAuthor <a href="mailto:pgearon at users.sourceforge.net">Paul Gearon</a>
  *
- * @modified $Date: 2005/01/05 04:58:20 $ by $Author: newmana $
+ * @copyright &copy;2001-2004 <a href="http://www.pisoftware.com/">Plugged In Software Pty Ltd</a>
  *
- * @maintenanceAuthor $Author: newmana $
- *
- * @copyright &copy;2001-2004
- *   <a href="http://www.pisoftware.com/">Plugged In Software Pty Ltd</a>
- *
  * @licence <a href="{@docRoot}/../../LICENCE">Mozilla Public License v1.1</a>
  */
 public class Variable implements ConstraintElement {
@@ -55,106 +50,76 @@
    */
   static final long serialVersionUID = -3242803845875986693L;
 
-  /**
-   * Description of the Field
-   */
+  /** Description of the Field */
   public final static Variable FROM = new Variable("_from");
 
-  /**
-   * The <var>name</var> property.
-   */
+  /** The <var>name</var> property. */
   private String name;
 
+
   /**
    * Create a new variable.
-   *
    * @param name the variable name (no leading <code>$</code> character)
    * @throws IllegalArgumentException if <var>name</var> is <code>null</code>
    */
   public Variable(String name) {
-
     // Validate "name" parameter
-    if (name == null) {
+    if (name == null) throw new IllegalArgumentException("Null \"name\" parameter");
+    if (name.indexOf(" ") != -1)  throw new IllegalArgumentException("\"" + name + "\" is a not a variable name");
 
-      throw new IllegalArgumentException("Null \"name\" parameter");
-    }
-
-    if (name.indexOf(" ") != -1) {
-
-      throw new IllegalArgumentException("\"" + name +
-          "\" is a not a variable name");
-    }
-
-    // Initialize fields
     this.name = name;
   }
 
+
   /**
    * Accessor for the <var>name</var> property.
-   *
-   * @return The Name value
+   * @return The value of the Name
    */
   public String getName() {
-
     return name;
   }
 
+
   /**
-   * METHOD TO DO
-   *
-   * @return RETURNED VALUE TO DO
+   * Clones this variable.
+   * @return A new variable that will compare as equal to this one.
    */
   public Object clone() {
-
-    if (name.equals("_from")) {
-
-      return FROM;
-    }
+    if (name.equals("_from")) return FROM;
     else {
-
       try {
         return super.clone();
+      } catch (CloneNotSupportedException e) {
+        throw new InternalError(e.toString());  // Should not happen
       }
-      catch (CloneNotSupportedException e) {
-        // Should never happen
-        throw new InternalError(e.toString());
-      }
     }
   }
 
+
   /**
    * Variables are equal by <var>name</var> .
    *
-   * @param object PARAMETER TO DO
-   * @return RETURNED VALUE TO DO
+   * @param object The other variable to compare to
+   * @return <code>true</code> if object is a Variable, and has the same name.
    */
   public boolean equals(Object object) {
-
-    if ( (object == null) || !Variable.class.equals(object.getClass())) {
-
-      return false;
-    }
-
-    return (object == this) || name.equals( ( (Variable) object).name);
+    if ((object == null) || !Variable.class.equals(object.getClass())) return false;
+    return (object == this) || name.equals(((Variable)object).name);
   }
 
   /**
-   * METHOD TO DO
-   *
-   * @return RETURNED VALUE TO DO
+   * Calculate a hash code that is relatively unique for this variable.
+   * @return An int encoded from this variable's name.
    */
   public int hashCode() {
-
     return name.hashCode();
   }
 
   /**
    * Legible representation of the variable.
-   *
    * @return a <q>$</q> prefixed to the <var>name</var>
    */
   public String toString() {
-
     return "$" + name;
   }
 }