/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
* Copyright (c) 2011 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.util.
Map;
import java.util.
Set;
import javax.faces.
FacesWrapper;
import javax.faces.context.
FacesContext;
import javax.faces.flow.
Flow;
/**
* <p class="changed_added_2_2">Provides a simple implementation of
* {@link ConfigurableNavigationHandler} that can be subclassed by developers wishing
* to provide specialized behavior to an existing {@link
* ConfigurableNavigationHandler} instance. The default implementation of all methods
* is to call through to the wrapped {@link ConfigurableNavigationHandler}.</p>
*
* <div class="changed_added_2_2">
*
* <p>Usage: extend this class and override {@link #getWrapped} to
* return the instance we are wrapping.</p>
*
* </div>
*
* @since 2.2
*/
public abstract class
ConfigurableNavigationHandlerWrapper extends
ConfigurableNavigationHandler implements
FacesWrapper<
ConfigurableNavigationHandler>{
/**
* @return the instance that we are wrapping.
*/
@
Override
public abstract
ConfigurableNavigationHandler getWrapped();
@
Override
public
NavigationCase getNavigationCase(
FacesContext context,
String fromAction,
String outcome) {
return
getWrapped().
getNavigationCase(
context,
fromAction,
outcome);
}
@
Override
public
Map<
String,
Set<
NavigationCase>>
getNavigationCases() {
return
getWrapped().
getNavigationCases();
}
@
Override
public
NavigationCase getNavigationCase(
FacesContext context,
String fromAction,
String outcome,
String toFlowDocumentId) {
return
getWrapped().
getNavigationCase(
context,
fromAction,
outcome,
toFlowDocumentId);
}
@
Override
public void
handleNavigation(
FacesContext context,
String fromAction,
String outcome) {
getWrapped().
handleNavigation(
context,
fromAction,
outcome);
}
@
Override
public void
performNavigation(
String outcome) {
getWrapped().
performNavigation(
outcome);
}
@
Override
public void
inspectFlow(
FacesContext context,
Flow flow) {
getWrapped().
inspectFlow(
context,
flow);
}
}