libjava/classpath/javax/naming/spi/ObjectFactory.java

   1 /* ObjectFactory.java --
   2    Copyright (C) 2001, 2004, 2006  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.naming.spi;
  40
  41 import java.util.Hashtable;
  42
  43 import javax.naming.Context;
  44 import javax.naming.Name;
  45
  46 /**
  47  * Represents a factory for creating the object. ObjectFactory performs the
  48  * operation, that is the opposite to the operation, performed by the
  49  * {@link StateFactory}. Classes, implementing this interface, must be public
  50  * and have public parameterless constructor.
  51  */
  52 public interface ObjectFactory
  53 {
  54   /**
  55    * Creates the object, using the specified name and location information. The
  56    * call of this method must be thread safe.
  57    *
  58    * @param refObj may provide the reference and location information. Can be null.
  59    * @param name the name of the new object in the scope of the specified naming
  60    *          context. Can be null if the name is not specified.
  61    * @param nameCtx the context, in which the object name is specified. Can be
  62    *          null if the name is specified in the scope of the default initial
  63    *          context.
  64    * @param environment the properties, providing additional information on how
  65    *          to create an object. Can be null if not additional information is
  66    *          provided.
  67    * @return the newly created object or null if the object cannot be created
  68    * @throws Exception if this factory suggest not to try creating of this
  69    *           object by other alternative factories
  70    *
  71    * @see NamingManager#getObjectInstance(Object, Name, Context, Hashtable)
  72    */
  73   Object getObjectInstance (Object refObj, Name name, Context nameCtx,
  74                             Hashtable<?, ?> environment)
  75     throws Exception;
  76 }