Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improved javadoc 

Signed-off-by: Greg Wilkins <gregw@webtide.com>
This commit is contained in:
Greg Wilkins 2022-11-22 18:39:03 +11:00
parent 07202102b8
commit 3e9403ef39
3 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/CombinedResource.java
View File

@ -32,9 +32,11 @@ import org.eclipse.jetty.util.URIUtil;
public class CombinedResource extends Resource
{
/**
* <p>Make a Resource containing a combination of other resources</p>
* @param resources multiple resources to combine as a single resource. Typically, they are directories.
* @return A Resource of multiple resources or a single resource if only 1 is passed, or null if none are passed
* <p>Make a Resource containing a combination of multiple directory resources.</p>
* @param resources multiple directory resources to combine as a single resource. Order is significant.
* @return A Resource of multiple resources or a single resource if only 1 is passed, or null if none are passed.
* Any Resource returned will always return {@code true} from {@link Resource#isDirectory()}
* @throws IllegalArgumentException if a non-directory resource is passed.
* @see CombinedResource
*/
static Resource combine(List<Resource> resources)

10
jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/Resource.java
View File

@ -221,12 +221,14 @@ public abstract class Resource implements Iterable<Resource>
}
/**
* <p>List of existing Resources contained in the given resource.</p>
* <p>List of contents of a directory {@link Resource}.</p>
*
* <p>Ordering is unspecified, so callers may wish to sort the return value to ensure deterministic behavior.</p>
* <p>Ordering is {@link java.nio.file.FileSystem} dependent, so callers may wish to sort the return value to ensure deterministic behavior.</p>
*
* @return a mutable list of resources contained in the tracked resource,
* or an empty immutable list if unable to build the list.
* @return a mutable list of resources contained in the directory resource,
* or an empty immutable list if unable to build the list (e.g. the resource is not a directory or not readable).
* @see Resource#isDirectory()
* @see Resource#isReadable()
*/
public List<Resource> list()
{

20
jetty-core/jetty-util/src/main/java/org/eclipse/jetty/util/resource/ResourceFactory.java
View File

@ -33,9 +33,13 @@ import org.eclipse.jetty.util.component.Dumpable;
public interface ResourceFactory
{
/**
* <p>Make a Resource containing a collection of other resources</p>
* @param resources multiple resources to combine as a single resource. Typically, they are directories.
* @return A Resource of multiple resources or a single resource if only 1 is passed, or null if none are passed
* <p>Make a directory Resource containing a collection of other directory {@link Resource}s</p>
* @param resources multiple directory {@link Resource}s to combine as a single resource. Order is significant.
* @return A {@link CombinedResource} for multiple resources;
* or a single {@link Resource} if only 1 is passed;
* or null if none are passed.
* The returned {@link Resource} will always return {@code true} from {@link Resource#isDirectory()}
* @throws IllegalArgumentException if a non-directory resource is passed.
* @see CombinedResource
*/
static Resource combine(List<Resource> resources)
@ -44,9 +48,13 @@ public interface ResourceFactory
}
/**
* <p>Make a Resource containing a collection of other resources</p>
* @param resources multiple resources to combine as a single resource. Typically, they are directories.
* @return A Resource of multiple resources.
* <p>Make a directory Resource containing a collection of directory {@link Resource}s</p>
* @param resources multiple directory {@link Resource}s to combine as a single resource. Order is significant.
* @return A {@link CombinedResource} for multiple resources;
* or a single {@link Resource} if only 1 is passed;
* or null if none are passed.
* The returned {@link Resource} will always return {@code true} from {@link Resource#isDirectory()}
* @throws IllegalArgumentException if a non-directory resource is passed.
* @see CombinedResource
*/
static Resource combine(Resource... resources)