javax.faces.application.ResourceHandlerWrapper Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.application;
import java.io.IOException;
import javax.faces.FacesWrapper;
import javax.faces.context.FacesContext;
/**
* Provides a simple
* implementation of {@link ResourceHandler} that can be subclassed by
* developers wishing to provide specialized behavior to an existing
* {@link ResourceHandler} instance. The default implementation of all
* methods is to call through to the wrapped {@link
* ResourceHandler}.
*
*
*
* Usage: extend this class and override {@link #getWrapped} to
* return the instance we are wrapping.
*
*
*
* @since 2.0
*/
public abstract class ResourceHandlerWrapper extends ResourceHandler implements FacesWrapper {
/**
* @return the instance that we are wrapping.
*/
public abstract ResourceHandler getWrapped();
// -------------------------------------------- Methods from ResourceHandler
/**
* The default behavior of this method
* is to call {@link ResourceHandler#createResource(String)} on the
* wrapped {@link ResourceHandler} object.
*/
public Resource createResource(String resourceName) {
return getWrapped().createResource(resourceName);
}
/**
* The default behavior of this method
* is to call {@link ResourceHandler#createResource(String, String)} on the wrapped
* {@link ResourceHandler} object.
*/
public Resource createResource(String resourceName, String libraryName) {
return getWrapped().createResource(resourceName, libraryName);
}
/**
* The default behavior of this method
* is to call {@link ResourceHandler#createResource(String, String,
* String)} on the wrapped {@link ResourceHandler} object.
*/
public Resource createResource(String resourceName,
String libraryName,
String contentType) {
return getWrapped().createResource(resourceName,
libraryName,
contentType);
}
/**
* The default behavior of this method
* is to call {@link
* ResourceHandler#handleResourceRequest(javax.faces.context.FacesContext)}
* on the wrapped {@link ResourceHandler} object.
*/
public void handleResourceRequest(FacesContext context) throws IOException {
getWrapped().handleResourceRequest(context);
}
/**
* The default behavior of this method
* is to call {@link ResourceHandler#isResourceRequest(javax.faces.context.FacesContext)} on the
* wrapped {@link ResourceHandler} object.
*/
public boolean isResourceRequest(FacesContext context) {
return getWrapped().isResourceRequest(context);
}
/**
* The default behavior of this method
* is to call {@link ResourceHandler#libraryExists(String)} on the
* wrapped {@link ResourceHandler} object.
*/
public boolean libraryExists(String libraryName) {
return getWrapped().libraryExists(libraryName);
}
/**
* The default behavior of this method
* is to call {@link ResourceHandler#getRendererTypeForResourceName(String)} on the
* wrapped {@link ResourceHandler} object.
*/
public String getRendererTypeForResourceName(String resourceName) {
return getWrapped().getRendererTypeForResourceName(resourceName);
}
}