Reference.java

/*
 * Javolution - Java(TM) Solution for Real-Time and Embedded Systems
 * Copyright (C) 2006 - Javolution (http://javolution.org/)
 * All rights reserved.
 * 
 * Permission to use, copy, modify, and distribute this software is
 * freely granted, provided that this notice is preserved.
 */
package javolution.lang;

/**
 * <p> This interface represents an object reference, the reachability level 
 *     of a reference varies based on the actual reference implementation.
 *     Here are the reachability levels for some of <i><b>J</b>avolution</i>
 *     references:<ul>
 *     <li> {@link javolution.context.PersistentContext.Reference PersistentContext.Reference} : 
 *          Reachable accross multiple program executions.</li>
 *     <li> {@link javolution.context.LocalContext.Reference LocalContext.Reference} : 
 *          Reachable only within the scope of the 
 *          {@link javolution.context.LocalContext LocalContext}
 *          where it has been set.</li>
 *     <li> {@link javolution.context.AllocatorContext.Reference AllocatorContext.Reference} :
 *          Reachable only within the scope of the  
 *          {@link javolution.context.AllocatorContext Allocator}
 *          where it has been created (factory produced).</li>
 *     </ul></p>
 * 
 * @author  <a href="mailto:jean-marie@dautelle.com">Jean-Marie Dautelle</a>
 * @version 3.3, May 10, 2005
 */
public interface Reference <T>  {

    /**
     * Returns the value this reference referes to.
     *
     * @return the referent or <code>null</code> if not set.
     */
     T  get();

    /**
     * Sets the value this reference referes to.
     *
     * @param value the reference value.
     */
    void set( T  value);

}