Jetty 12.0.6 · org.eclipse.jetty.util.resource.Resource

Modifier and Type	Field and Description
private static final Logger	LOG
private static final LinkOption[]	NO_FOLLOW_LINKS

Access	Constructor and Description
public	Resource()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this Resource is deeply contains the other Resource, false otherwise contains(Resource the resource other) Return true if this resource deeply contains the other Resource.
public void	copyTo(Path the destination file to create or directory to use. destination) Copy the Resource to the new destination file or directory
public static String	dump(Resource resource)
pack-priv void	ensureDirExists(Path dir)
public boolean	Returns: true if the represented resource exists. exists() Equivalent to `Files#exists(Path, LinkOption...)` with the following parameters: `getPath()` and `LinkOption#NOFOLLOW_LINKS`.
public Collection<Resource>	Returns: A collection of all Resources deeply contained within this resource if it is a directory, otherwise an empty collection is returned. getAllResources() Get a deep collection of contained resources.
public abstract String	Returns: the filename of the resource, or "" if there are no path segments (eg: path of "/"), or null if resource cannot determine a filename. getFileName() The file name of the resource.
public abstract String	Returns: the full name of the resource, or null if there is no name for the resource. getName() The full name of the resource.
public abstract Path	Returns: the path or null if there is no Path representation. getPath() Return the Path corresponding to this resource.
public Path	Returns: a relative Path representing the path from this resource to the other resource, or null if not able to represent other resources as relative to this resource getPathTo(Resource The other resource that may be contained in this resource other) Get the relative path from this Resource to a possibly contained resource.
public URI	Returns: The real URI location of this resource. getRealURI() The real URI of the resource.
public abstract URI	Returns: a URI representing the given resource, or null if there is no URI representation of the resource. getURI() URI representing the resource.
public boolean	isAlias() Returns: true if this Resource is an alias to another real Resource
public boolean	Returns: true if this Resource is contained, false otherwise isContainedIn(Resource the containing resource container) Return true if this resource is contained in the Resource r, either because r is a folder or a jar file or any form of resource capable of containing other resources.
public abstract boolean	Returns: true if the represented resource is a container/directory. isDirectory() Return true if resource represents a directory of potential resources.
public abstract boolean	Returns: true if the represented resource exists, and can read from. isReadable() True if the resource is readable.
public Iterator<Resource>	Returns: the iterator of Resources. iterator() Implements java.lang.Iterable.iterator. Return an Iterator of all Resource's referenced in this Resource.
public Instant	Returns: the last modified time instant, or `Instant#EPOCH` if unable to obtain last modified. lastModified() The time the resource was last modified.
public long	Returns: the length of the resource in bytes, or -1L if unable to provide a size (such as a directory resource). length() Length of the resource.
public List<Resource>	Returns: 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). list() List of contents of a directory `Resource`.
public InputStream	Returns: an input stream to the resource or null if one is not available. newInputStream() Creates a new input stream to the resource.
public ReadableByteChannel	Returns: a readable `java.nio.channels.ByteChannel` to the resource or null if one is not available. newReadableByteChannel() Readable ByteChannel for the resource.
public abstract Resource	Returns: an existing Resource representing the requested subUriPath, or null if resource does not exist. resolve(String the encoded subUriPath subUriPath) Resolve an existing Resource.
pack-priv static Path	resolveDifferentFileSystem(Path path, Path relative)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOG	back to summary
private static final Logger LOG

NO_FOLLOW_LINKS	back to summary
private static final LinkOption[] NO_FOLLOW_LINKS

Resource	back to summary
public Resource()

Method Detail

contains back to summary

contains	back to summary
public boolean contains(Resource other) Return true if this resource deeply contains the other Resource. This resource must be a directory or a jar file or any form of resource capable of containing other resources. Parameters other:Resource the resource Returns:boolean true if this Resource is deeply contains the other Resource, false otherwise See Also `isContainedIn(Resource)`

public boolean contains(Resource other)

Return true if this resource deeply contains the other Resource. This resource must be a directory or a jar file or any form of resource capable of containing other resources.

Parameters

other:Resource: the resource

Returns:boolean

true if this Resource is deeply contains the other Resource, false otherwise

See Also

isContainedIn(Resource)

copyTo	back to summary
public void copyTo(Path destination) throws IOException Copy the Resource to the new destination file or directory Parameters destination:Path the destination file to create or directory to use. Exceptions IOException: if unable to copy the resource

copyTo

back to summary

public void copyTo(Path destination) throws IOException

Copy the Resource to the new destination file or directory

Parameters

destination:Path: the destination file to create or directory to use.

Exceptions

IOException:: if unable to copy the resource

dump	back to summary
public static String dump(Resource resource)

ensureDirExists	back to summary
pack-priv void ensureDirExists(Path dir) throws IOException

exists back to summary

exists	back to summary
public boolean exists() Equivalent to `Files#exists(Path, LinkOption...)` with the following parameters: `getPath()` and `LinkOption#NOFOLLOW_LINKS`. Returns:boolean true if the represented resource exists.

public boolean exists()

Equivalent to Files#exists(Path, LinkOption...) with the following parameters: getPath() and LinkOption#NOFOLLOW_LINKS.

Returns:boolean: true if the represented resource exists.

getAllResources	back to summary
public Collection<Resource> getAllResources() Get a deep collection of contained resources. Returns:Collection<Resource> A collection of all Resources deeply contained within this resource if it is a directory, otherwise an empty collection is returned.

getAllResources

back to summary

public Collection<Resource> getAllResources()

Get a deep collection of contained resources.

Returns:Collection<Resource>: A collection of all Resources deeply contained within this resource if it is a directory, otherwise an empty collection is returned.

getFileName back to summary

getFileName	back to summary
public abstract String getFileName() The file name of the resource. This is the last segment of the path. Returns:String the filename of the resource, or "" if there are no path segments (eg: path of "/"), or null if resource cannot determine a filename. See Also `Path#getFileName()`

public abstract String getFileName()

The file name of the resource.

This is the last segment of the path.

Returns:String: the filename of the resource, or "" if there are no path segments (eg: path of "/"), or null if resource cannot determine a filename.
See Also: Path#getFileName()

getName	back to summary
public abstract String getName() The full name of the resource. Returns:String the full name of the resource, or null if there is no name for the resource.

getName

back to summary

public abstract String getName()

The full name of the resource.

Returns:String: the full name of the resource, or null if there is no name for the resource.

getPath	back to summary
public abstract Path getPath() Return the Path corresponding to this resource. Returns:Path the path or null if there is no Path representation.

getPath

back to summary

public abstract Path getPath()

Return the Path corresponding to this resource.

Returns:Path: the path or null if there is no Path representation.

getPathTo	back to summary
public Path getPathTo(Resource other) Get the relative path from this Resource to a possibly contained resource. Parameters other:Resource The other resource that may be contained in this resource Returns:Path a relative Path representing the path from this resource to the other resource, or null if not able to represent other resources as relative to this resource

getPathTo

back to summary

public Path getPathTo(Resource other)

Get the relative path from this Resource to a possibly contained resource.

Parameters

other:Resource: The other resource that may be contained in this resource

Returns:Path

a relative Path representing the path from this resource to the other resource, or null if not able to represent other resources as relative to this resource

getRealURI back to summary

getRealURI	back to summary
public URI getRealURI() The real URI of the resource. If this Resource is an alias, (`isAlias()`), this URI will be different from `getURI()`, and will point to the real name/location of the Resource. Returns:URI The real URI location of this resource.

public URI getRealURI()

The real URI of the resource.

If this Resource is an alias, (isAlias()), this URI will be different from getURI(), and will point to the real name/location of the Resource.

Returns:URI: The real URI location of this resource.

getURI	back to summary
public abstract URI getURI() URI representing the resource. Returns:URI a URI representing the given resource, or null if there is no URI representation of the resource.

getURI

back to summary

public abstract URI getURI()

URI representing the resource.

Returns:URI: a URI representing the given resource, or null if there is no URI representation of the resource.

isAlias	back to summary
public boolean isAlias() Returns:boolean true if this Resource is an alias to another real Resource

isContainedIn back to summary

isContainedIn	back to summary
public boolean isContainedIn(Resource container) Return true if this resource is contained in the Resource r, either because r is a folder or a jar file or any form of resource capable of containing other resources. Parameters container:Resource the containing resource Returns:boolean true if this Resource is contained, false otherwise See Also `contains(Resource)`

public boolean isContainedIn(Resource container)

Return true if this resource is contained in the Resource r, either because r is a folder or a jar file or any form of resource capable of containing other resources.

Parameters

container:Resource: the containing resource

Returns:boolean

true if this Resource is contained, false otherwise

See Also

contains(Resource)

isDirectory	back to summary
public abstract boolean isDirectory() Return true if resource represents a directory of potential resources. Returns:boolean true if the represented resource is a container/directory.

isDirectory

back to summary

public abstract boolean isDirectory()

Return true if resource represents a directory of potential resources.

Returns:boolean: true if the represented resource is a container/directory.

isReadable	back to summary
public abstract boolean isReadable() True if the resource is readable. Returns:boolean true if the represented resource exists, and can read from.

isReadable

back to summary

public abstract boolean isReadable()

True if the resource is readable.

Returns:boolean: true if the represented resource exists, and can read from.

iterator back to summary

iterator	back to summary
public Iterator<Resource> iterator() Implements java.lang.Iterable.iterator. Return an Iterator of all Resource's referenced in this Resource. This is meaningful if you have a `CombinedResource`, otherwise it will be a single entry Iterator of this resource. Returns:Iterator<Resource> the iterator of Resources. Annotations @Override

public Iterator<Resource> iterator()

Implements java.lang.Iterable.iterator.

Return an Iterator of all Resource's referenced in this Resource.

This is meaningful if you have a CombinedResource, otherwise it will be a single entry Iterator of this resource.

Returns:Iterator<Resource>

the iterator of Resources.

Annotations

@Override

lastModified back to summary

lastModified	back to summary
public Instant lastModified() The time the resource was last modified. Returns:Instant the last modified time instant, or `Instant#EPOCH` if unable to obtain last modified.

public Instant lastModified()

The time the resource was last modified.

Returns:Instant: the last modified time instant, or Instant#EPOCH if unable to obtain last modified.

length	back to summary
public long length() Length of the resource. Returns:long the length of the resource in bytes, or -1L if unable to provide a size (such as a directory resource).

length

back to summary

public long length()

Length of the resource.

Returns:long: the length of the resource in bytes, or -1L if unable to provide a size (such as a directory resource).

list back to summary

list	back to summary
public List<Resource> list() List of contents of a directory `Resource`. Ordering is `java.nio.file.FileSystem` dependent, so callers may wish to sort the return value to ensure deterministic behavior. Returns:List<Resource> 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 Also `Resource#isDirectory()`, `Resource#isReadable()`

public List<Resource> list()

List of contents of a directory Resource.

Ordering is java.nio.file.FileSystem dependent, so callers may wish to sort the return value to ensure deterministic behavior.

Returns:List<Resource>: 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 Also: Resource#isDirectory(), Resource#isReadable()

newInputStream	back to summary
public InputStream newInputStream() throws IOException Creates a new input stream to the resource. Returns:InputStream an input stream to the resource or null if one is not available. Exceptions IOException: if there is a problem opening the input stream

newInputStream

back to summary

public InputStream newInputStream() throws IOException

Creates a new input stream to the resource.

Returns:InputStream

an input stream to the resource or null if one is not available.

Exceptions

IOException:: if there is a problem opening the input stream

newReadableByteChannel back to summary

newReadableByteChannel	back to summary
public ReadableByteChannel newReadableByteChannel() throws IOException Readable ByteChannel for the resource. Returns:ReadableByteChannel a readable `java.nio.channels.ByteChannel` to the resource or null if one is not available. Exceptions IOException: if unable to open the readable bytechannel for the resource.

public ReadableByteChannel newReadableByteChannel() throws IOException

Readable ByteChannel for the resource.

Returns:ReadableByteChannel

a readable java.nio.channels.ByteChannel to the resource or null if one is not available.

Exceptions

IOException:: if unable to open the readable bytechannel for the resource.

resolve	back to summary
public abstract Resource resolve(String subUriPath) Resolve an existing Resource. Parameters subUriPath:String the encoded subUriPath Returns:Resource an existing Resource representing the requested subUriPath, or null if resource does not exist. Exceptions IllegalArgumentException: if subUriPath is invalid

resolve

back to summary

public abstract Resource resolve(String subUriPath)

Resolve an existing Resource.

Parameters

subUriPath:String: the encoded subUriPath

Returns:Resource

an existing Resource representing the requested subUriPath, or null if resource does not exist.

Exceptions

IllegalArgumentException:: if subUriPath is invalid

resolveDifferentFileSystem	back to summary
pack-priv static Path resolveDifferentFileSystem(Path path, Path relative)

public abstract Class Resource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail