Class PackageResourceReference
- java.lang.Object
-
- org.apache.wicket.request.resource.ResourceReference
-
- org.apache.wicket.request.resource.PackageResourceReference
-
- All Implemented Interfaces:
Serializable
,org.apache.wicket.util.io.IClusterable
- Direct Known Subclasses:
CssResourceReference
,JavaScriptResourceReference
,MetaInfStaticResourceReference
public class PackageResourceReference extends ResourceReference
This is a ResourceReference that knows how to find and serve resources located in the Java package (i.e. next to the class files).- Author:
- Tobias Soloschenko
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.wicket.request.resource.ResourceReference
ResourceReference.Key, ResourceReference.LambdaResourceReference, ResourceReference.UrlAttributes
-
-
Constructor Summary
Constructors Constructor Description PackageResourceReference(Class<?> scope, String name)
Construct.PackageResourceReference(Class<?> scope, String name, Locale locale, String style, String variation)
Construct.PackageResourceReference(String name)
Construct.PackageResourceReference(ResourceReference.Key key)
Construct.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
getMinifiedName()
PackageResource
getResource()
Returns the resource.ResourceReference.UrlAttributes
getUrlAttributes()
Allows to specify which locale, style and variation values will the generated URL for this resource reference have.PackageResourceReference
readBuffered(boolean readBuffered)
If the package resource should be read buffered.
WARNING - if the stream is not read buffered compressors will not work, because they require the whole content to be read into memory.
(IJavaScriptCompressor
,
ICssCompressor
,
IScopeAwareTextResourceProcessor
)protected void
removeCompressFlagIfUnnecessary(PackageResource resource)
Method allowing to remove the compress flag if the resource has been detected as a minified one (i.e.-
Methods inherited from class org.apache.wicket.request.resource.ResourceReference
canBeRegistered, equals, getDependencies, getExtension, getKey, getLocale, getName, getScope, getStyle, getVariation, hashCode, of, of, toString
-
-
-
-
Constructor Detail
-
PackageResourceReference
public PackageResourceReference(ResourceReference.Key key)
Construct.- Parameters:
key
-
-
PackageResourceReference
public PackageResourceReference(Class<?> scope, String name, Locale locale, String style, String variation)
Construct.- Parameters:
scope
-name
-locale
-style
-variation
-
-
PackageResourceReference
public PackageResourceReference(Class<?> scope, String name)
Construct.- Parameters:
scope
-name
-
-
PackageResourceReference
public PackageResourceReference(String name)
Construct.- Parameters:
name
-
-
-
Method Detail
-
getResource
public PackageResource getResource()
Description copied from class:ResourceReference
Returns the resource.- Specified by:
getResource
in classResourceReference
- Returns:
- resource instance
- See Also:
ResourceReference.getResource()
-
removeCompressFlagIfUnnecessary
protected final void removeCompressFlagIfUnnecessary(PackageResource resource)
Method allowing to remove the compress flag if the resource has been detected as a minified one (i.e. ending with .min.EXT) This method is to be called by subclasses overridinggetResource
if they want to rely on default minification detection handling see WICKET-5250 for further explanation- Parameters:
resource
- resource to check
-
getMinifiedName
protected String getMinifiedName()
- Returns:
- How the minified file should be named.
-
getUrlAttributes
public ResourceReference.UrlAttributes getUrlAttributes()
Description copied from class:ResourceReference
Allows to specify which locale, style and variation values will the generated URL for this resource reference have.- Overrides:
getUrlAttributes
in classResourceReference
- Returns:
- url attributes
-
readBuffered
public PackageResourceReference readBuffered(boolean readBuffered)
If the package resource should be read buffered.
WARNING - if the stream is not read buffered compressors will not work, because they require the whole content to be read into memory.
(IJavaScriptCompressor
,
ICssCompressor
,
IScopeAwareTextResourceProcessor
)- Parameters:
readBuffered
- if the package resource should be read buffered- Returns:
- the current package resource
-
-