View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2001-2004 Open World Ltd
4   //
5   // This file is part of MillScript.
6   //
7   // MillScript is free software; you can redistribute it and/or modify it under
8   // the terms of the GNU General Public License as published by the Free
9   // Software Foundation; either version 2 of the License, or (at your option)
10  // any later version.
11  //
12  // MillScript is distributed in the hope that it will be useful, but WITHOUT
13  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  // more details.
16  //
17  // You should have received a copy of the GNU General Public License along with
18  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19  // Place, Suite 330, Boston, MA  02111-1307  USA
20  ////////////////////////////////////////////////////////////////////////////////
21  package org.millscript.millscript.vm;
22  
23  /**
24   * Refs are the run-time representation of variables.  They are simply a slot
25   * pointing to the value of the variable.  Maybe they will be augmented with
26   * debugging info later on e.g.  variable name.
27   */
28  public final class Ref {
29  
30      /**
31       * The value of the variable.
32       */
33      public Object value = null;
34  
35      /**
36       * Constructs a new <code>Ref</code> with a default <code>null</code>
37       * value.
38       */
39      public Ref() {
40      }
41  
42      /**
43       * Constructs a new <code>Ref</code> with the specified value.
44       *
45       * @param v the value for this reference
46       */
47      public Ref( final Object v ) {
48          this.value = v;
49      }
50  
51      /**
52       * Returns the value associated with this reference.
53       *
54       * @return  this references value
55       */
56      public Object getValue() {
57          return value;
58      }
59  
60      /**
61       * @see java.lang.Object#toString()
62       */
63      @Override
64      public String toString() {
65          return "R( " + value + " )";
66      }
67  
68  }