cvs commit: jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/directory ComponentReference.java

[do...@apache.org]

donaldp     2002/08/24 19:14:09

  Added:       containerkit/src/java/org/apache/excalibur/containerkit/directory
                        ComponentReference.java
  Log:
  Add in reference returned from Directory.
  Allows invalidation (essentially resource
  de-allocation) and profile retrieval (for now),
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/directory/ComponentReference.java
  
  Index: ComponentReference.java
  ===================================================================
  /*
   * Copyright (C) The Apache Software Foundation. All rights reserved.
   *
   * This software is published under the terms of the Apache Software License
   * version 1.1, a copy of which has been included with this distribution in
   * the LICENSE.txt file.
   */
  package org.apache.excalibur.containerkit.directory;
  
  import org.apache.excalibur.containerkit.registry.ComponentProfile;
  
  /**
   * This interface defines a resource returned from the
   * {@link ComponentDirectory}.
   *
   * @author <a href="mailto:peter at apache.org">Peter Donald</a>
   * @version $Revision: 1.1 $ $Date: 2002/08/25 02:14:09 $
   */
  public interface ComponentReference
  {
      /**
       * Return the underlying object representing the Component.
       *
       * @return the underlying object representing the Component
       */
      Object getComponent();
  
      /**
       * @todo Determine if this is reallly needed. It is only
       * returned as  a result of Directory lookup, hence should
       * know the type.
       * @todo Determine if this could be replace by getInfo()
       */
      ComponentProfile getProfile();
  
      /**
       * Invalidate the component reference. After the reference has been
       * invalidated, any calls made on the Compnent will have undefined
       * results.
       */
      void invalidate();
  }
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>