Module org.apache.wicket.util

Package org.apache.wicket.util.resource

Class FileSystemResourceStream

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.util.resource.FileSystemResourceStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, IClusterable, IFixedLocationResourceStream, IResourceStream, IModifiable

public class FileSystemResourceStream
extends AbstractResourceStream
implements IFixedLocationResourceStream

A FileSystemResourceStream is an IResourceStream implementation for Java NIO paths.

Author:

Tobias Soloschenko

See Also:

• IResourceStream
• IModifiable
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileSystemResourceStream(File file)	Constructor.
FileSystemResourceStream(Path path)	Constructor.
FileSystemResourceStream(File file)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the resource.
String	getContentType()	Gets the mime type of this resource
InputStream	getInputStream()	Gets the resource stream.
final Path	getPath()
Instant	lastModifiedTime()	Gets the last time this modifiable thing changed.
Bytes	length()	Gets the size of this resource
String	locationAsString()
String	toString()

Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream

getLocale, getStyle, getVariation, setLocale, setStyle, setVariation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FileSystemResourceStream

public FileSystemResourceStream(Path path)

Constructor.

Parameters:

path - Path containing resource

FileSystemResourceStream

public FileSystemResourceStream(File file)

Constructor.

Parameters:

file - File containing resource

FileSystemResourceStream

public FileSystemResourceStream(File file)

Constructor.

Parameters:

file - File containing resource

Method Details

getInputStream

public InputStream getInputStream()
                           throws ResourceStreamNotFoundException

Description copied from interface: IResourceStream

Gets the resource stream. You should not directly close this stream. Instead call the close() method on IResourceStream.

Specified by:

getInputStream in interface IResourceStream

Returns:

Returns the inputStream.

Throws:

ResourceStreamNotFoundException

See Also:

• IResourceStream.close()

close

public void close()
           throws IOException

Description copied from interface: IResourceStream

Closes the resource. Normally, this includes closing any underlying input stream returned by getInputStream().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface IResourceStream

Throws:

IOException

getContentType

public String getContentType()

Description copied from interface: IResourceStream

Gets the mime type of this resource

Specified by:

getContentType in interface IResourceStream

Overrides:

getContentType in class AbstractResourceStream

Returns:

The mime type of this resource, such as "image/jpeg" or "text/html". Return null to let ResourceStreamRequestHandler handle the Content-Type automatically

getPath

public final Path getPath()

Returns:

The path this resource resides in, if any.

lastModifiedTime

public Instant lastModifiedTime()

Description copied from interface: IModifiable

Gets the last time this modifiable thing changed.

Specified by:

lastModifiedTime in interface IModifiable

Overrides:

lastModifiedTime in class AbstractResourceStream

Returns:

the last modification Time or null if that information is not available

length

public Bytes length()

Description copied from interface: IResourceStream

Gets the size of this resource

Specified by:

length in interface IResourceStream

Overrides:

length in class AbstractResourceStream

Returns:

The size of this resource in the number of bytes, or null if unknown

locationAsString

public String locationAsString()

Specified by:

locationAsString in interface IFixedLocationResourceStream

Returns:

The fixed location as a string, e.g. the file name or the URL. Return null to avoid caching the markup.

toString

public String toString()

Overrides:

toString in class Object