PicoContainer example source code file (ObjectReference.java)

This example PicoContainer source code file (ObjectReference.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - PicoContainer tags/keywords

object, object, objectreference, objectreference

The PicoContainer ObjectReference.java source code

/*****************************************************************************
 * Copyright (C) PicoContainer Organization. All rights reserved.            *
 * ------------------------------------------------------------------------- *
 * The software in this package is published under the terms of the BSD      *
 * style license a copy of which has been included with this distribution in *
 * the LICENSE.txt file.                                                     *
 *                                                                           *
 *****************************************************************************/
package org.picocontainer;

/**
 * A way to refer to objects that are stored in "awkward" places (for example inside a
 * <code>HttpSession or {@link ThreadLocal}).
 * <p/>
 * This interface is typically implemented by someone integrating Pico into an existing container.
 *
 * @author Joe Walnes
 */
public interface ObjectReference {
    /**
     * Retrieve an actual reference to the object. Returns null if the reference is not available
     * or has not been populated yet.
     * 
     * @return an actual reference to the object.
     */
    Object get();

    /**
     * Assign an object to the reference.
     * 
     * @param item the object to assign to the reference. May be <code>null.
     */
    void set(Object item);
}