All Implemented Interfaces:

FacesWrapper<Resource>

public abstract class ResourceWrapper
extends Resource
implements FacesWrapper<Resource>

Since:

2.0

• Field Summary

  • Fields inherited from class javax.faces.application.Resource

    COMPONENT_RESOURCE_KEY

• Constructor Summary

  Constructors

  Constructor and Description
  ResourceWrapper ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  String	getContentType () The default behavior of this method is to call Resource.getContentType() on the wrapped ResourceHandler object.
  InputStream	getInputStream () The default behavior of this method is to call Resource.getInputStream() on the wrapped ResourceHandler object.
  String	getLibraryName () The default behavior of this method is to call Resource.getLibraryName() on the wrapped ResourceHandler object.
  String	getRequestPath () The default behavior of this method is to call Resource.getRequestPath() on the wrapped ResourceHandler object.
  String	getResourceName () The default behavior of this method is to call Resource.getResourceName() on the wrapped ResourceHandler object.
  Map<String,String>	getResponseHeaders () The default behavior of this method is to call Resource.getResponseHeaders() on the wrapped ResourceHandler object.
  URL	getURL () The default behavior of this method is to call Resource.getURL() on the wrapped ResourceHandler object.
  abstract Resource	getWrapped () A class that implements this interface uses this method to return an instance of the class being wrapped.
  void	setContentType (String contentType) The default behavior of this method is to call Resource.setContentType(String) on the wrapped ResourceHandler object.
  void	setLibraryName (String libraryName) The default behavior of this method is to call Resource.setLibraryName(String) on the wrapped ResourceHandler object.
  void	setResourceName (String resourceName) The default behavior of this method is to call Resource.setResourceName(String) on the wrapped ResourceHandler object.
  boolean	userAgentNeedsUpdate (FacesContext context) The default behavior of this method is to call Resource.userAgentNeedsUpdate(javax.faces.context.FacesContext) on the wrapped ResourceHandler object.

  • Methods inherited from class javax.faces.application.Resource

    toString

  • Methods inherited from class java.lang.Object

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

• Constructor Detail

  • ResourceWrapper

    public ResourceWrapper()

• Method Detail

  • getWrapped

    public abstract Resource getWrapped()

    Description copied from interface: FacesWrapper

    A class that implements this interface uses this method to return an instance of the class being wrapped.

    Specified by:

    getWrapped in interface FacesWrapper<Resource>

    Returns:

    the instance that we are wrapping.

  • getInputStream

    public InputStream getInputStream()
     throws IOException 

    The default behavior of this method is to call Resource.getInputStream() on the wrapped ResourceHandler object.

    Specified by:

    getInputStream in class Resource

    Returns:

    an InputStream containing the bytes of the resource.

    Any EL expressions present in the resource must be evaluated before serving the bytes of the resource. Note that due to browser and server caching, EL expressions in a resource file will generally only be evaluated once, when the resource is first served up. Therefore, using EL expressions that refer to per-request data is not advisable since this data can become stale.

    Throws:

    IOException - if the current request is not a resource request.

  • getURL

    public URL getURL()

    The default behavior of this method is to call Resource.getURL() on the wrapped ResourceHandler object.

    Specified by:

    getURL in class Resource

    Returns:

    Return an actual URL instance that refers to this resource instance.

  • getResponseHeaders

    public Map<String,String> getResponseHeaders()

    The default behavior of this method is to call Resource.getResponseHeaders() on the wrapped ResourceHandler object.

    Specified by:

    getResponseHeaders in class Resource

    Returns:

    a mutable Map<String, String> of headers that will be included with the response.

  • getRequestPath

    public String getRequestPath()

    The default behavior of this method is to call Resource.getRequestPath() on the wrapped ResourceHandler object.

    Specified by:

    getRequestPath in class Resource

    Returns:

    the path to this resource, intended to be included in the encoded view that is sent to the browser when sending a faces response.

  • userAgentNeedsUpdate

    public boolean userAgentNeedsUpdate(FacesContext context)

    The default behavior of this method is to call Resource.userAgentNeedsUpdate(javax.faces.context.FacesContext) on the wrapped ResourceHandler object.

    Specified by:

    userAgentNeedsUpdate in class Resource

    Returns:

    true or false depending on whether or not the user-agent needs an update of this resource.

  • getContentType

    public String getContentType()

    The default behavior of this method is to call Resource.getContentType() on the wrapped ResourceHandler object.

    Overrides:

    getContentType in class Resource

    Returns:

    the MIME content-type for this resource.

  • setContentType

    public void setContentType(String contentType)

    The default behavior of this method is to call Resource.setContentType(String) on the wrapped ResourceHandler object.

    Overrides:

    setContentType in class Resource

    Parameters:

    contentType - the MIME content-type for this resource. The default implementation must accept null as a parameter.

  • getLibraryName

    public String getLibraryName()

    The default behavior of this method is to call Resource.getLibraryName() on the wrapped ResourceHandler object.

    Overrides:

    getLibraryName in class Resource

    Returns:

    Return the libraryName for this resource. May be null.

  • setLibraryName

    public void setLibraryName(String libraryName)

    The default behavior of this method is to call Resource.setLibraryName(String) on the wrapped ResourceHandler object.

    Overrides:

    setLibraryName in class Resource

    Parameters:

    libraryName - the libraryName for this resource. The default implementation must accept null for the libraryName.

  • getResourceName

    public String getResourceName()

    The default behavior of this method is to call Resource.getResourceName() on the wrapped ResourceHandler object.

    Overrides:

    getResourceName in class Resource

    Returns:

    Return the resourceName for this resource. Will never be null.

  • setResourceName

    public void setResourceName(String resourceName)

    The default behavior of this method is to call Resource.setResourceName(String) on the wrapped ResourceHandler object.

    Overrides:

    setResourceName in class Resource

    Parameters:

    resourceName - a non-null String.