summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/naming/spi/Resolver.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/classpath/javax/naming/spi/Resolver.java')
-rw-r--r--libjava/classpath/javax/naming/spi/Resolver.java35
1 files changed, 32 insertions, 3 deletions
diff --git a/libjava/classpath/javax/naming/spi/Resolver.java b/libjava/classpath/javax/naming/spi/Resolver.java
index d80fb616924..eb3eeb56079 100644
--- a/libjava/classpath/javax/naming/spi/Resolver.java
+++ b/libjava/classpath/javax/naming/spi/Resolver.java
@@ -1,5 +1,5 @@
/* Resolver.java --
- Copyright (C) 2001, 2005 Free Software Foundation, Inc.
+ Copyright (C) 2001, 2005, 2006 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -38,18 +38,47 @@ exception statement from your version. */
package javax.naming.spi;
+import javax.naming.Context;
import javax.naming.Name;
import javax.naming.NamingException;
+import javax.naming.NotContextException;
/**
+ * <p>Represents the object, capable for the at least partial name resolution.
+ * The object is not necessay capable for the complete name resolution and
+ * need not implement the {@link Context}.</p>
+ * <p>
+ * Both passed parameters and returned results are owned by the caller.</p>
+ *
* @author Warren Levy (warrenl@redhat.com)
- * @date June 1, 2001
*/
-
public interface Resolver
{
+ /**
+ * Partially resolve the name, stopping at the first instance of the context
+ * that is an instance of the contextType
+ *
+ * @param name the name to resolve
+ * @param contextType the class of the context, on that the resolution should
+ * be terminated
+ * @return the complete or partial name resolution
+ * @throws NotContextException if the context of the contextType is not found
+ * @throws NamingException on other failure
+ */
ResolveResult resolveToClass(Name name, Class contextType)
throws NamingException;
+
+ /**
+ * Partially resolve the name, stopping at the first instance of the context
+ * that is an instance of the contextType
+ *
+ * @param name the name to resolve
+ * @param contextType the class of the context, on that the resolution should
+ * be terminated
+ * @return the complete or partial name resolution
+ * @throws NotContextException if the context of the contextType is not found
+ * @throws NamingException on other failure
+ */
ResolveResult resolveToClass(String name, Class contextType)
throws NamingException;
}