433479 Improved resource javadoc

This commit is contained in:
Greg Wilkins 2014-04-25 14:36:59 +02:00
parent 15661722b3
commit bdecc7bd89
2 changed files with 12 additions and 5 deletions

View File

@ -1384,8 +1384,9 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
/* ------------------------------------------------------------ */
/**
* @param base
* The resourceBase to set.
* Set the base resource for this context.
* @param base The resource used as the base for all static content of this context.
* @see #setResourceBase(String)
*/
public void setBaseResource(Resource base)
{
@ -1393,9 +1394,11 @@ public class ContextHandler extends ScopedHandler implements Attributes, Gracefu
}
/* ------------------------------------------------------------ */
/**
* @param resourceBase
* The base resource as a string.
/**
* Set the base resource for this context.
* @param resourceBase A string representing the base resource for the context. Any string accepted
* by {@link Resource#newResource(String)} may be passed and the call is equivalent to
* <code>setBaseResource(newResource(resourceBase));</code>
*/
public void setResourceBase(String resourceBase)
{

View File

@ -46,6 +46,10 @@ import org.eclipse.jetty.util.log.Logger;
/* ------------------------------------------------------------ */
/**
* Abstract resource class.
* <p>
* This class provides a resource abstraction, where a resource may be
* a file, a URL or an entry in a jar file.
* </p>
*/
public abstract class Resource implements ResourceFactory, Closeable
{