Module org.apache.wicket.core

Package org.apache.wicket.core.util.resource

Class PackageResourceStream

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.core.util.resource.PackageResourceStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, IClusterable, IResourceStream, IModifiable

public class PackageResourceStream
extends AbstractResourceStream

An IResourceStream that reads data from a resource in the classpath. It simply delegates all operations to the IResourceStream returned by the application's IResourceStreamLocator.

Author:

Jean-Baptiste Quenot, Tobias Soloschenko

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PackageResourceStream(Class<?> scope, String path)	Obtains an IResourceStream from the application's IResourceStreamLocator.locate(Class, String)
PackageResourceStream(Class<?> scope, String path, Locale locale, String style, String variation)	Obtains an IResourceStream from the application's IResourceStreamLocator.locate(Class, String)

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.
Instant	lastModifiedTime()	Gets the last time this modifiable thing changed.
Bytes	length()	Gets the size of this resource

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, toString, wait, wait, wait

Constructor Details

PackageResourceStream

public PackageResourceStream(Class<?> scope,
 String path)

Obtains an IResourceStream from the application's IResourceStreamLocator.locate(Class, String)

Parameters:

scope - This argument will be used to get the class loader for loading the package resource, and to determine what package it is in.

path - The path to the resource

PackageResourceStream

public PackageResourceStream(Class<?> scope,
 String path,
 Locale locale,
 String style,
 String variation)

Obtains an IResourceStream from the application's IResourceStreamLocator.locate(Class, String)

Parameters:

scope - This argument will be used to get the class loader for loading the package resource, and to determine what package it is in.

path - The path to the resource

locale - the locale of the resource to get

style - the style of the resource to get

variation - the variation of the resource to get

Method Details

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().

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

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.

Returns:

Returns the inputStream.

Throws:

ResourceStreamNotFoundException

See Also:

• IResourceStream.close()

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

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