|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wicket.request.resource.ResourceReferenceRegistry
public class ResourceReferenceRegistry
Allows to register and lookup ResourceReference
s per Application.
Application.getResourceReferenceRegistry()
,
Application.newResourceReferenceRegistry()
Nested Class Summary | |
---|---|
static class |
ResourceReferenceRegistry.DefaultResourceReferenceFactory
A simple implementation of IResourceReferenceFactory that creates
PackageResourceReference |
Constructor Summary | |
---|---|
ResourceReferenceRegistry()
Constructor. |
|
ResourceReferenceRegistry(IResourceReferenceFactory resourceReferenceFactory)
Constructor |
Method Summary | |
---|---|
void |
clearAutoAddedEntries()
Unregisters all auto-added Resource References |
protected ResourceReference |
createDefaultResourceReference(ResourceReference.Key key)
Creates a default resource reference in case no registry entry and it was requested to create one. |
int |
getAutoAddedCacheSize()
|
int |
getAutoAddedCapacity()
Gets cache size in number of entries |
ResourceReference |
getResourceReference(Class<?> scope,
String name,
Locale locale,
String style,
String variation,
boolean strict,
boolean createIfNotFound)
Get a resource reference matching the parameters from the registry or if not found and requested, create an default resource reference and add it to the registry. |
ResourceReference |
getResourceReference(ResourceReference.Key key,
boolean strict,
boolean createIfNotFound)
Get a resource reference matching the parameters from the registry or if not found and requested, create an default resource reference and add it to the registry. |
int |
getSize()
|
boolean |
registerResourceReference(ResourceReference reference)
Registers the given ResourceReference . |
void |
setAutoAddedCapacity(int autoAddedCapacity)
Set the cache size in number of entries |
ResourceReference |
unregisterResourceReference(ResourceReference.Key key)
Unregisters a ResourceReference by its identifier. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ResourceReferenceRegistry()
Uses DefaultResourceReferenceFactory to create ResourceReference when there is no registered one for the requested attributes
public ResourceReferenceRegistry(IResourceReferenceFactory resourceReferenceFactory)
resourceReferenceFactory
- The factory that will create ResourceReference by Key when there is no registered oneMethod Detail |
---|
public final boolean registerResourceReference(ResourceReference reference)
ResourceReference
.
ResourceReference.canBeRegistered()
must return true
. Else, the resource
reference will not be registered.
reference
- the reference to register
true
if the resource was registered successfully or has been registered previously
already.public final ResourceReference unregisterResourceReference(ResourceReference.Key key)
ResourceReference
by its identifier.
key
- the ResourceReference
's identifier
null
if the registry did not contain an entry for this key.public final ResourceReference getResourceReference(Class<?> scope, String name, Locale locale, String style, String variation, boolean strict, boolean createIfNotFound)
Part of the search is scanning the class (scope) and it's superclass for static ResourceReference fields. Found fields get registered automatically (but are different from auto-generated ResourceReferences).
scope
- The scope of resource reference (e.g. the Component's class)name
- The name of resource reference (e.g. filename)locale
- see Componentstyle
- see Componentvariation
- see Componentstrict
- If true, "weaker" combination of scope, name, locale etc. are not testedcreateIfNotFound
- If true a default resource reference is created if no entry can be found in the
registry. The newly created resource reference will be added to the registry.
createDefaultResourceReference(org.apache.wicket.request.resource.ResourceReference.Key)
,
ClassScanner
public final ResourceReference getResourceReference(ResourceReference.Key key, boolean strict, boolean createIfNotFound)
Part of the search is scanning the class (scope) and it's superclass for static ResourceReference fields. Found fields get registered automatically (but are different from auto-generated ResourceReferences).
key
- The data making up the resource referencestrict
- If true, "weaker" combination of scope, name, locale etc. are not testedcreateIfNotFound
- If true a default resource reference is created if no entry can be found in the
registry. The newly created resource reference will be added to the registry.
createDefaultResourceReference(org.apache.wicket.request.resource.ResourceReference.Key)
,
ClassScanner
protected ResourceReference createDefaultResourceReference(ResourceReference.Key key)
A PackageResourceReference
will be created by default
key
- the data making up the resource reference
ResourceReference
created or null
if not successfulpublic final void setAutoAddedCapacity(int autoAddedCapacity)
autoAddedCapacity
- A value < 0 will disable aging of auto-create resource references. They will be
created, added to the registry and live their until manually removed or the
application shuts down.public final int getAutoAddedCapacity()
public final void clearAutoAddedEntries()
public final int getAutoAddedCacheSize()
public final int getSize()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |