Author: gturrell
Date: Thu Feb 1 06:14:05 2007
New Revision: 502219
URL: http://svn.apache.org/viewvc?view=rev&rev=502219
Log:
Fixed javadoc for URIResolver interface
Modified:
incubator/woden/branches/M7/src/org/apache/woden/resolver/URIResolver.java
Modified:
incubator/woden/branches/M7/src/org/apache/woden/resolver/URIResolver.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/resolver/URIResolver.java?view=diff&rev=502219&r1=502218&r2=502219
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/resolver/URIResolver.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/resolver/URIResolver.java
Thu Feb 1 06:14:05 2007
@@ -23,30 +23,31 @@
import org.apache.woden.WSDLException;
-/**
- * URI Resolver interface
- *
- * To associate a URI resolver programmatically, the following should be
called prior to parser invocation.
- * Example:
- *
- * WSDLFactory factory = WSDLFactory.newInstance();
- * WSDLReader reader = factory.newWSDLReader();
- * URIResolver resolver = new XXXURIResolver(); // XXXURIResolver
implements this interface
- * reader.setURIResolver(resolver);
- * ...
- * DescriptionElement descElem = reader.readWSDL(wsdlurl);
- *
- *
+/**
+ *Implementations of this interface may be used to specify a custom URI
resolver.
+ *Such an implementation can then be used to override the default Woden URI
Resolver.
+ *To associate a URI resolver programmatically, the following should be called
prior to parser invocation.
+ *<p>Example:
+ *<br>WSDLFactory factory = WSDLFactory.newInstance();
+ *<br>WSDLReader reader = factory.newWSDLReader();
+ *<br>// MyURIResolver implements this interface ...
+ *<br>URIResolver resolver = new MyURIResolver();
+ *<br>reader.setURIResolver(resolver);
+ *<br>...
+ *<br>// Then, can parse a document and the assigned resolver will be used
internally...
+ *<br>Description desc = reader.readWSDL("http://myplace/mydoc.wsdl";);
+ [EMAIL PROTECTED] org.apache.woden.WSDLFactory
+ [EMAIL PROTECTED] org.apache.woden.WSDLReader
*/
public interface URIResolver {
/**
- * Implementation should return null if there is no resolution for the
uri
+ * Implementation should return null if there is no resolution for the
uri.
*
- * @param uri
- * @return the resolved URI to read from
- * @throws WSDLException
- * @throws IOException
+ * @param uri the uri to be resolved
+ * @return the resolved URI (or null if no resolution available)
+ * @throws WSDLException
+ * @throws IOException
*/
public URI resolveURI(URI uri) throws WSDLException, IOException;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
