[jboss-cvs] JBossAS SVN: r73127 - projects/metadata/trunk/src/main/java/org/jboss/metadata/ejb/jboss.

[jboss-cvs-commits at lists.jboss.org]

Author: scott.stark at jboss.org
Date: 2008-05-07 20:01:51 -0400 (Wed, 07 May 2008)
New Revision: 73127

Modified:
   projects/metadata/trunk/src/main/java/org/jboss/metadata/ejb/jboss/JBossEnterpriseBeanMetaData.java
Log:
JBMETA-35, javadoc for determineResolvedJndiName

Modified: projects/metadata/trunk/src/main/java/org/jboss/metadata/ejb/jboss/JBossEnterpriseBeanMetaData.java
===================================================================
--- projects/metadata/trunk/src/main/java/org/jboss/metadata/ejb/jboss/JBossEnterpriseBeanMetaData.java	2008-05-07 23:55:52 UTC (rev 73126)
+++ projects/metadata/trunk/src/main/java/org/jboss/metadata/ejb/jboss/JBossEnterpriseBeanMetaData.java	2008-05-08 00:01:51 UTC (rev 73127)
@@ -569,10 +569,19 @@
    abstract public String determineJndiName();
 
    /**
+    * Determine the jndi name for the proxy associated with iface. This uses
+    * the bean DefaultJndiBindingPolicy. This will be one of:
+    * - {@link #getJndiBindingPolicy()} the metadata policy
+    * - the argument defaultPolicy
+    * - BasicJndiBindingPolicy(base-jndi-name)
     * 
-    * @param iface
-    * @param defaultPolicy
-    * @return
+    * @param iface - the fully qualified class name of the interface, or one
+    *    of the {@linkplain KnownInterfaces}. May be null in which case the base
+    *    name as determined by {@link #getMappedName()} or
+    *    {@link #determineJndiName()} is used.
+    * @param defaultPolicy - an optional DefaultJndiBindingPolicy to use if
+    *    {@link #getJndiBindingPolicy()} is null.
+    * @return the resolved jndi name
     */
    @XmlTransient
    public String determineResolvedJndiName(String iface, DefaultJndiBindingPolicy defaultPolicy)