org.apache.wicket.request.resource
Class ResourceReference

java.lang.Object
  extended by org.apache.wicket.request.resource.ResourceReference
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
PackageResourceReference, SharedResourceReference, TextTemplateResourceReference

public abstract class ResourceReference
extends java.lang.Object
implements java.io.Serializable

Reference to a resource. Can be used to reference global resources.

Even though resource reference is just a factory for resources, it still needs to be identified by a globally unique identifier, combination of scope and name. Those are used to generate URLs for resource references. locale, style and variation are optional fields to allow having specific references for individual locales, styles and variations.

Author:
Matej Knopp
See Also:
Serialized Form

Nested Class Summary
static class ResourceReference.UrlAttributes
           
 
Constructor Summary
ResourceReference(java.lang.Class<?> scope, java.lang.String name)
          Creates new ResourceReference instance.
ResourceReference(java.lang.Class<?> scope, java.lang.String name, java.util.Locale locale, java.lang.String style, java.lang.String variation)
          Creates new ResourceReference instance.
ResourceReference(java.lang.String name)
          Construct.
 
Method Summary
 boolean canBeRegistered()
          Can be used to disable registering certain resource references in ResourceReferenceRegistry.
 boolean equals(java.lang.Object obj)
           
 java.util.Locale getLocale()
           
 java.lang.String getName()
           
abstract  IResource getResource()
          Returns the resource.
 java.lang.Class<?> getScope()
           
 java.lang.String getStyle()
           
 ResourceReference.UrlAttributes getUrlAttributes()
          Allows to specify which locale, style and variation values will the generated URL for this resource reference have.
 java.lang.String getVariation()
           
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceReference

public ResourceReference(java.lang.Class<?> scope,
                         java.lang.String name,
                         java.util.Locale locale,
                         java.lang.String style,
                         java.lang.String variation)
Creates new ResourceReference instance.

Parameters:
scope - mandatory parameter
name - mandatory parameter
locale -
style -
variation -

ResourceReference

public ResourceReference(java.lang.Class<?> scope,
                         java.lang.String name)
Creates new ResourceReference instance.

Parameters:
scope - mandatory parameter
name - mandatory parameter
locale -
style -
variation -

ResourceReference

public ResourceReference(java.lang.String name)
Construct.

Parameters:
name -
Method Detail

getName

public java.lang.String getName()
Returns:
name

getScope

public java.lang.Class<?> getScope()
Returns:
scope

getLocale

public java.util.Locale getLocale()
Returns:
locale

getStyle

public java.lang.String getStyle()
Returns:
style

getVariation

public java.lang.String getVariation()
Returns:
variation

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
See Also:
Object.equals(java.lang.Object)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()

getResource

public abstract IResource getResource()
Returns the resource.

Returns:
resource instance

getUrlAttributes

public ResourceReference.UrlAttributes getUrlAttributes()
Allows to specify which locale, style and variation values will the generated URL for this resource reference have.

Returns:
url attributes

canBeRegistered

public boolean canBeRegistered()
Can be used to disable registering certain resource references in ResourceReferenceRegistry.

Returns:
true if this reference can be registered, false otherwise.


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.