| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Mon Nov 23 11:46:34 CST 2020 --> |
| <title>Resource (Jetty :: Project 9.4.35.v20201120 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-11-23"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Resource (Jetty :: Project 9.4.35.v20201120 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":10,"i3":6,"i4":42,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":6,"i12":6,"i13":42,"i14":10,"i15":6,"i16":6,"i17":10,"i18":10,"i19":38,"i20":10,"i21":10,"i22":10,"i23":6,"i24":9,"i25":6,"i26":6,"i27":6,"i28":6,"i29":9,"i30":9,"i31":9,"i32":9,"i33":9,"i34":9,"i35":9,"i36":9,"i37":9,"i38":42,"i39":6,"i40":10,"i41":9,"i42":9,"i43":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Resource.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.util.resource</a></div> |
| <h2 title="Class Resource" class="title">Class Resource</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.util.resource.Resource</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code>, <code><a href="ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="EmptyResource.html" title="class in org.eclipse.jetty.util.resource">EmptyResource</a></code>, <code><a href="FileResource.html" title="class in org.eclipse.jetty.util.resource">FileResource</a></code>, <code><a href="PathResource.html" title="class in org.eclipse.jetty.util.resource">PathResource</a></code>, <code><a href="ResourceCollection.html" title="class in org.eclipse.jetty.util.resource">ResourceCollection</a></code>, <code><a href="URLResource.html" title="class in org.eclipse.jetty.util.resource">URLResource</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">Resource</span> |
| extends java.lang.Object |
| implements <a href="ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a>, java.io.Closeable</pre> |
| <div class="block">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></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__defaultUseCaches">__defaultUseCaches</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Resource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPath(java.lang.String)">addPath</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the resource contained inside the current resource with the |
| given name.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Release any temporary resources held by the resource.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyTo(java.io.File)">copyTo</a></span>​(java.io.File destination)</code></th> |
| <td class="colLast"> |
| <div class="block">Copy the Resource to the new destination file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete()">delete</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Deletes the given resource</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encode(java.lang.String)">encode</a></span>​(java.lang.String uri)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="../URIUtil.html" title="class in org.eclipse.jetty.util"><code>URIUtil</code></a> or <a href="../UrlEncoded.html" title="class in org.eclipse.jetty.util"><code>UrlEncoded</code></a> instead</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exists()">exists</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finalize()">finalize</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAlias()">getAlias</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllResources()">getAllResources</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAssociate()">getAssociate</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultUseCaches()">getDefaultUseCaches</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract java.io.File</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFile()">getFile</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">File representing the given resource.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract java.io.InputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInputStream()">getInputStream</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Input stream to the resource</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListHTML(java.lang.String,boolean)">getListHTML</a></span>​(java.lang.String base, |
| boolean parent)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getListHTML(java.lang.String,boolean,java.lang.String)"><code>getListHTML(String, boolean, String)</code></a> instead and supply raw query string.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListHTML(java.lang.String,boolean,java.lang.String)">getListHTML</a></span>​(java.lang.String base, |
| boolean parent, |
| java.lang.String query)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the resource list as a HTML directory listing.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The name of the resource.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract java.nio.channels.ReadableByteChannel</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadableByteChannel()">getReadableByteChannel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Readable ByteChannel for the resource.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResource(java.lang.String)">getResource</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a resource from within this resource.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURI()">getURI</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">URI representing the resource.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>abstract java.net.URL</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURL()">getURL</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use {<a href="#getURI()"><code>getURI()</code></a>.toURL() instead.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWeakETag()">getWeakETag</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Generate a weak ETag reference for this Resource.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWeakETag(java.lang.String)">getWeakETag</a></span>​(java.lang.String suffix)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAlias()">isAlias</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isContainedIn(org.eclipse.jetty.util.resource.Resource)">isContainedIn</a></span>​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> r)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isContainedIn(org.eclipse.jetty.util.resource.Resource,org.eclipse.jetty.util.resource.Resource)">isContainedIn</a></span>​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> r, |
| <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> containingResource)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDirectory()">isDirectory</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>abstract long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastModified()">lastModified</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Time resource was last modified.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#length()">length</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Length of the resource.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#list()">list</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">list of resource names contained in the given resource.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newClassPathResource(java.lang.String)">newClassPathResource</a></span>​(java.lang.String resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Find a classpath resource.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newClassPathResource(java.lang.String,boolean,boolean)">newClassPathResource</a></span>​(java.lang.String name, |
| boolean useCaches, |
| boolean checkParents)</code></th> |
| <td class="colLast"> |
| <div class="block">Find a classpath resource.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.io.File)">newResource</a></span>​(java.io.File file)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.lang.String)">newResource</a></span>​(java.lang.String resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a resource from a string.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.lang.String,boolean)">newResource</a></span>​(java.lang.String resource, |
| boolean useCaches)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a resource from a string.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.net.URI)">newResource</a></span>​(java.net.URI uri)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a resource from a uri.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.net.URL)">newResource</a></span>​(java.net.URL url)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a resource from a url.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResource(java.nio.file.Path)">newResource</a></span>​(java.nio.file.Path path)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a Resource from provided path</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newSystemResource(java.lang.String)">newSystemResource</a></span>​(java.lang.String resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct a system resource from a string.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release()">release</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#close()"><code>close()</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameTo(org.eclipse.jetty.util.resource.Resource)">renameTo</a></span>​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> dest)</code></th> |
| <td class="colLast"> |
| <div class="block">Rename the given resource</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAssociate(java.lang.Object)">setAssociate</a></span>​(java.lang.Object o)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDefaultUseCaches(boolean)">setDefaultUseCaches</a></span>​(boolean useCaches)</code></th> |
| <td class="colLast"> |
| <div class="block">Change the default setting for url connection caches.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>static java.net.URL</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toURL(java.io.File)">toURL</a></span>​(java.io.File file)</code></th> |
| <td class="colLast"> |
| <div class="block">Generate a properly encoded URL from a <code>File</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeTo(java.io.OutputStream,long,long)">writeTo</a></span>​(java.io.OutputStream out, |
| long start, |
| long count)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="__defaultUseCaches"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>__defaultUseCaches</h4> |
| <pre>public static boolean __defaultUseCaches</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Resource</h4> |
| <pre>public Resource()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setDefaultUseCaches(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultUseCaches</h4> |
| <pre class="methodSignature">public static void setDefaultUseCaches​(boolean useCaches)</pre> |
| <div class="block">Change the default setting for url connection caches. |
| Subsequent URLConnections will use this default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>useCaches</code> - true to enable URL connection caches, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefaultUseCaches()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultUseCaches</h4> |
| <pre class="methodSignature">public static boolean getDefaultUseCaches()</pre> |
| </li> |
| </ul> |
| <a id="newResource(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.net.URI uri) |
| throws java.net.MalformedURLException</pre> |
| <div class="block">Construct a resource from a uri.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - A URI.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Resource object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code> - Problem accessing URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newResource(java.net.URL)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.net.URL url)</pre> |
| <div class="block">Construct a resource from a url.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>url</code> - A URL.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Resource object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.lang.String resource) |
| throws java.io.IOException</pre> |
| <div class="block">Construct a resource from a string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - A URL or filename.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Resource object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code> - Problem accessing URI</dd> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newResource(java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.lang.String resource, |
| boolean useCaches) |
| throws java.io.IOException</pre> |
| <div class="block">Construct a resource from a string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - A URL or filename.</dd> |
| <dd><code>useCaches</code> - controls URLConnection caching</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Resource object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code> - Problem accessing URI</dd> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newResource(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.io.File file)</pre> |
| </li> |
| </ul> |
| <a id="newResource(java.nio.file.Path)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newResource​(java.nio.file.Path path)</pre> |
| <div class="block">Construct a Resource from provided path</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Resource for the provided path</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.4.10</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newSystemResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSystemResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newSystemResource​(java.lang.String resource) |
| throws java.io.IOException</pre> |
| <div class="block">Construct a system resource from a string. |
| The resource is tried as classloader resource before being |
| treated as a normal resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - Resource as string representation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new Resource</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - Problem accessing resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newClassPathResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newClassPathResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newClassPathResource​(java.lang.String resource)</pre> |
| <div class="block">Find a classpath resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the relative name of the resource</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Resource or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newClassPathResource(java.lang.String,boolean,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newClassPathResource</h4> |
| <pre class="methodSignature">public static <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> newClassPathResource​(java.lang.String name, |
| boolean useCaches, |
| boolean checkParents)</pre> |
| <div class="block">Find a classpath resource. |
| The <code>Class.getResource(String)</code> method is used to lookup the resource. If it is not |
| found, then the <a href="../Loader.html#getResource(java.lang.String)"><code>Loader.getResource(String)</code></a> method is used. |
| If it is still not found, then <code>ClassLoader.getSystemResource(String)</code> is used. |
| Unlike <code>ClassLoader.getSystemResource(String)</code> this method does not check for normal resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The relative name of the resource</dd> |
| <dd><code>useCaches</code> - True if URL caches are to be used.</dd> |
| <dd><code>checkParents</code> - True if forced searching of parent Classloaders is performed to work around |
| loaders with inverted priorities</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Resource or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isContainedIn(org.eclipse.jetty.util.resource.Resource,org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isContainedIn</h4> |
| <pre class="methodSignature">public static boolean isContainedIn​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> r, |
| <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> containingResource) |
| throws java.net.MalformedURLException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="finalize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finalize</h4> |
| <pre class="methodSignature">protected void finalize()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>finalize</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isContainedIn(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isContainedIn</h4> |
| <pre class="methodSignature">public abstract boolean isContainedIn​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> r) |
| throws java.net.MalformedURLException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="release()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre class="methodSignature">public final void release()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#close()"><code>close()</code></a></div> |
| </div> |
| <div class="block">Release any temporary resources held by the resource.</div> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public abstract void close()</pre> |
| <div class="block">Release any temporary resources held by the resource.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="exists()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exists</h4> |
| <pre class="methodSignature">public abstract boolean exists()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the represented resource exists.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDirectory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectory</h4> |
| <pre class="methodSignature">public abstract boolean isDirectory()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the represented resource is a container/directory. |
| if the resource is not a file, resources ending with "/" are |
| considered directories.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lastModified()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastModified</h4> |
| <pre class="methodSignature">public abstract long lastModified()</pre> |
| <div class="block">Time resource was last modified.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last modified time as milliseconds since unix epoch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="length()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre class="methodSignature">public abstract long length()</pre> |
| <div class="block">Length of the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the length of the resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getURL()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURL</h4> |
| <pre class="methodSignature">@Deprecated |
| public abstract java.net.URL getURL()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use {<a href="#getURI()"><code>getURI()</code></a>.toURL() instead.</div> |
| </div> |
| <div class="block">URL representing the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a URL representing the given resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURI</h4> |
| <pre class="methodSignature">public java.net.URI getURI()</pre> |
| <div class="block">URI representing the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an URI representing the given resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFile</h4> |
| <pre class="methodSignature">public abstract java.io.File getFile() |
| throws java.io.IOException</pre> |
| <div class="block">File representing the given resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an File representing the given resource or NULL if this |
| is not possible.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to get the resource due to permissions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">public abstract java.lang.String getName()</pre> |
| <div class="block">The name of the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInputStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre class="methodSignature">public abstract java.io.InputStream getInputStream() |
| throws java.io.IOException</pre> |
| <div class="block">Input stream to the resource</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an input stream to the resource</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to open the input stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getReadableByteChannel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadableByteChannel</h4> |
| <pre class="methodSignature">public abstract java.nio.channels.ReadableByteChannel getReadableByteChannel() |
| throws java.io.IOException</pre> |
| <div class="block">Readable ByteChannel for the resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an readable bytechannel to the resource or null if one is not available.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to open the readable bytechannel for the resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="delete()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre class="methodSignature">public abstract boolean delete() |
| throws java.lang.SecurityException</pre> |
| <div class="block">Deletes the given resource</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if resource was found and successfully deleted, false if resource didn't exist or was unable to |
| be deleted.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.SecurityException</code> - if unable to delete due to permissions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="renameTo(org.eclipse.jetty.util.resource.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameTo</h4> |
| <pre class="methodSignature">public abstract boolean renameTo​(<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> dest) |
| throws java.lang.SecurityException</pre> |
| <div class="block">Rename the given resource</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dest</code> - the destination name for the resource</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the resource was renamed, false if the resource didn't exist or was unable to be renamed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.SecurityException</code> - if unable to rename due to permissions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="list()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>list</h4> |
| <pre class="methodSignature">public abstract java.lang.String[] list()</pre> |
| <div class="block">list of resource names contained in the given resource. |
| Ordering is unspecified, so callers may wish to sort the return value to ensure deterministic behavior.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of resource names contained in the given resource, or null. |
| Note: The resource names are not URL encoded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addPath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPath</h4> |
| <pre class="methodSignature">public abstract <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> addPath​(java.lang.String path) |
| throws java.io.IOException, |
| java.net.MalformedURLException</pre> |
| <div class="block">Returns the resource contained inside the current resource with the |
| given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The path segment to add, which is not encoded</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Resource for the resolved path within this Resource.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to resolve the path</dd> |
| <dd><code>java.net.MalformedURLException</code> - if the resolution of the path fails because the input path parameter is malformed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResource</h4> |
| <pre class="methodSignature">public <a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a> getResource​(java.lang.String path)</pre> |
| <div class="block">Get a resource from within this resource. |
| <p> |
| This method is essentially an alias for <a href="#addPath(java.lang.String)"><code>addPath(String)</code></a>, but without checked exceptions. |
| This method satisfied the <a href="ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource"><code>ResourceFactory</code></a> interface.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ResourceFactory.html#getResource(java.lang.String)">getResource</a></code> in interface <code><a href="ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The path to the resource</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resource or null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ResourceFactory.html#getResource(java.lang.String)"><code>ResourceFactory.getResource(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="encode(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre class="methodSignature">@Deprecated |
| public java.lang.String encode​(java.lang.String uri)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="../URIUtil.html" title="class in org.eclipse.jetty.util"><code>URIUtil</code></a> or <a href="../UrlEncoded.html" title="class in org.eclipse.jetty.util"><code>UrlEncoded</code></a> instead</div> |
| </div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the uri to encode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null (this is deprecated)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAssociate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAssociate</h4> |
| <pre class="methodSignature">public java.lang.Object getAssociate()</pre> |
| </li> |
| </ul> |
| <a id="setAssociate(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAssociate</h4> |
| <pre class="methodSignature">public void setAssociate​(java.lang.Object o)</pre> |
| </li> |
| </ul> |
| <a id="isAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAlias</h4> |
| <pre class="methodSignature">public boolean isAlias()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this Resource is an alias to another real Resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlias</h4> |
| <pre class="methodSignature">public java.net.URI getAlias()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The canonical Alias of this resource or null if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getListHTML(java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListHTML</h4> |
| <pre class="methodSignature">@Deprecated |
| public java.lang.String getListHTML​(java.lang.String base, |
| boolean parent) |
| throws java.io.IOException</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#getListHTML(java.lang.String,boolean,java.lang.String)"><code>getListHTML(String, boolean, String)</code></a> instead and supply raw query string.</div> |
| </div> |
| <div class="block">Get the resource list as a HTML directory listing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base</code> - The base URL</dd> |
| <dd><code>parent</code> - True if the parent directory should be included</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String of HTML</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to get the list of resources as HTML</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getListHTML(java.lang.String,boolean,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListHTML</h4> |
| <pre class="methodSignature">public java.lang.String getListHTML​(java.lang.String base, |
| boolean parent, |
| java.lang.String query) |
| throws java.io.IOException</pre> |
| <div class="block">Get the resource list as a HTML directory listing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base</code> - The base URL</dd> |
| <dd><code>parent</code> - True if the parent directory should be included</dd> |
| <dd><code>query</code> - query params</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String of HTML</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeTo(java.io.OutputStream,long,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre class="methodSignature">public void writeTo​(java.io.OutputStream out, |
| long start, |
| long count) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - the output stream to write to</dd> |
| <dd><code>start</code> - First byte to write</dd> |
| <dd><code>count</code> - Bytes to write or -1 for all of them.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to copy the Resource to the output</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copyTo(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyTo</h4> |
| <pre class="methodSignature">public void copyTo​(java.io.File destination) |
| throws java.io.IOException</pre> |
| <div class="block">Copy the Resource to the new destination file. |
| <p> |
| Will not replace existing destination file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>destination</code> - the destination file to create</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to copy the resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getWeakETag()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWeakETag</h4> |
| <pre class="methodSignature">public java.lang.String getWeakETag()</pre> |
| <div class="block">Generate a weak ETag reference for this Resource.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the weak ETag reference for this resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getWeakETag(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWeakETag</h4> |
| <pre class="methodSignature">public java.lang.String getWeakETag​(java.lang.String suffix)</pre> |
| </li> |
| </ul> |
| <a id="getAllResources()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllResources</h4> |
| <pre class="methodSignature">public java.util.Collection<<a href="Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a>> getAllResources()</pre> |
| </li> |
| </ul> |
| <a id="toURL(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toURL</h4> |
| <pre class="methodSignature">public static java.net.URL toURL​(java.io.File file) |
| throws java.net.MalformedURLException</pre> |
| <div class="block">Generate a properly encoded URL from a <code>File</code> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>file</code> - Target file.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>URL of the target file.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.net.MalformedURLException</code> - if unable to convert File to URL</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Resource.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |