Author: psteitz Date: Wed Dec 22 10:53:11 2004 New Revision: 123136 URL: http://svn.apache.org/viewcvs?view=rev&rev=123136 Log: Javadoc. Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java
Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/EjbRef.java Wed Dec 22 10:53:11 2004 @@ -82,6 +82,8 @@ * @param home Home interface classname * @param remote Remote interface classname * @param link EJB link + * @param factory Class name of the object's factory + * @param factoryLocation Location from which to load the factory */ public EjbRef(String ejbType, String home, String remote, String link, String factory, String factoryLocation) { @@ -114,6 +116,14 @@ /** * Retrieves the class name of the factory of the object to which this * reference refers. + * <p> + * If the factory class name is not set and the + * <code>Context.OBJECT_FACTORIES</code> system property is not present, + * the name of the default EJB factory is returned + * ("org.apache.naming.factory.EjbFactory"). Null is returned if the + * factory class name is not set, but the system property is present. + * + * @return the factory class name */ public String getFactoryClassName() { String factory = super.getFactoryClassName(); Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/NamingContext.java Wed Dec 22 10:53:11 2004 @@ -86,7 +86,7 @@ * * @param env environment * @param name external context name - * @bindings initial context bindings + * @param bindings initial context bindings * @throws NamingException if a naming exception is encountered */ public NamingContext(Hashtable env, String name, Hashtable bindings) Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceEnvRef.java Wed Dec 22 10:53:11 2004 @@ -75,6 +75,14 @@ /** * Retrieves the class name of the factory of the object to which this * reference refers. + * <p> + * If the factory class name is not set and the + * <code>Context.OBJECT_FACTORIES</code> system property is not present, + * the name of the default ResourceEnv factory is returned + * ("org.apache.naming.factory.ResourceEnvFactory"). Null is returned if + * the factory class name is not set, but the system property is present. + * + * @return The factory class name */ public String getFactoryClassName() { String factory = super.getFactoryClassName(); Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceLinkRef.java Wed Dec 22 10:53:11 2004 @@ -67,6 +67,8 @@ * * @param resourceClass Resource class * @param globalName Global name + * @param factory Factory class name + * @param factoryLocation Location from which to load the factory */ public ResourceLinkRef(String resourceClass, String globalName, String factory, String factoryLocation) { @@ -88,6 +90,14 @@ /** * Retrieves the class name of the factory of the object to which this * reference refers. + * <p> + * If the factory class name is not set and the + * <code>Context.OBJECT_FACTORIES</code> system property is not present, + * the name of the default ResourceLink factory is returned + * ("org.apache.naming.factory.ResourceLinkFactory"). Null is returned if + * the factory class name is not set, but the system property is present. + * + * @return The factory class name */ public String getFactoryClassName() { String factory = super.getFactoryClassName(); Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/ResourceRef.java Wed Dec 22 10:53:11 2004 @@ -69,6 +69,7 @@ * Resource Reference. * * @param resourceClass Resource class + * @param description Resource description * @param scope Resource scope * @param auth Resource authetication */ @@ -82,8 +83,11 @@ * Resource Reference. * * @param resourceClass Resource class + * @param description Resource description * @param scope Resource scope - * @param auth Resource authetication + * @param auth Resource authentication + * @param factory Factory class name + * @param factoryLocation Location from which to load the factory */ public ResourceRef(String resourceClass, String description, String scope, String auth, String factory, @@ -114,6 +118,14 @@ /** * Retrieves the class name of the factory of the object to which this * reference refers. + * <p> + * If the factory class name is not set and the + * <code>Context.OBJECT_FACTORIES</code> system property is not present, + * the name of the default Resource factory is returned + * ("org.apache.naming.factory.ResourceFactory"). Null is returned if + * the factory class name is not set, but the system property is present. + * + * @return The factory class name */ public String getFactoryClassName() { String factory = super.getFactoryClassName(); Modified: incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java?view=diff&rev=123136&p1=incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java&r1=123135&p2=incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java&r2=123136 ============================================================================== --- incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java (original) +++ incubator/directory/naming/trunk/core/src/java/org/apache/naming/TransactionRef.java Wed Dec 22 10:53:11 2004 @@ -45,7 +45,7 @@ /** - * Resource Reference. + * Transaction Reference. */ public TransactionRef() { this(null, null); @@ -53,9 +53,9 @@ /** - * Resource Reference. + * Transaction Reference. * - * @param factory Resource factory + * @param factory Factory class name * @param factoryLocation Factory location */ public TransactionRef(String factory, String factoryLocation) { @@ -72,6 +72,14 @@ /** * Retrieves the class name of the factory of the object to which this * reference refers. + * <p> + * If the factory class name is not set and the + * <code>Context.OBJECT_FACTORIES</code> system property is not present, + * the name of the default transaction factory is returned + * ("org.apache.naming.factory.TransactionFactory"). Null is returned if the + * factory class name is not set, but the system property is present. + * + * @return Factory class name */ public String getFactoryClassName() { String factory = super.getFactoryClassName();
