View Javadoc

1   /*
2    * @(#) Reference.java Dec 9, 2003
3    * 
4    * Copyright (c) 2003 Delft University of Technology Jaffalaan 5, 2628 BX Delft,
5    * the Netherlands All rights reserved.
6    * 
7    * This software is proprietary information of Delft University of Technology
8    * The code is published under the General Public License
9    */
10  package nl.tudelft.simulation.event.ref;
11  
12  import java.io.Serializable;
13  
14  /***
15   * A Reference interface defining the indirect pointer access to an object.
16   * <p>
17   * (c) copyright 2003 <a href="http://www.simulation.tudelft.nl">Delft
18   * University of Technology </a>, the Netherlands. <br>
19   * See for project information <a
20   * href="http://www.simulation.tudelft.nl">www.simulation.tudelft.nl </a> <br>
21   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
22   * License (GPL) </a>, no warranty <br>
23   * 
24   * @author <a href="http://www.simulation.tudelft.nl/people/jacobs.html">Peter
25   *         Jacobs </a>
26   * @version 1.2 2004-03-18
27   * @see java.lang.ref.Reference
28   * @since 1.2
29   */
30  public interface Reference extends Serializable
31  {
32  	/***
33  	 * Returns this reference object's referent. If this reference object has
34  	 * been cleared, either by the program or by the garbage collector, then
35  	 * this method returns <code>null</code>.
36  	 * 
37  	 * @return The object to which this reference refers, or <code>null</code>
38  	 *         if this reference object has been cleared
39  	 */
40  	Object get();
41  }