javax.faces.application.ConfigurableNavigationHandlerWrapper Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
* Copyright (c) 2011-2017 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.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;
/**
* 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}.
*
* Usage: extend this class and push the implementation being wrapped to the
* constructor and use {@link #getWrapped} to access the instance being wrapped.
*
* @since 2.2
*/
public abstract class ConfigurableNavigationHandlerWrapper extends ConfigurableNavigationHandler implements FacesWrapper{
private ConfigurableNavigationHandler wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public ConfigurableNavigationHandlerWrapper() {
}
/**
* If this configurable navigation handler has been decorated,
* the implementation doing the decorating should push the implementation being wrapped to this constructor.
* The {@link #getWrapped()} will then return the implementation being wrapped.
*
* @param wrapped The implementation being wrapped.
* @since 2.3
*/
public ConfigurableNavigationHandlerWrapper(ConfigurableNavigationHandler wrapped) {
this.wrapped = wrapped;
}
@Override
public ConfigurableNavigationHandler getWrapped() {
return wrapped;
}
@Override
public NavigationCase getNavigationCase(FacesContext context, String fromAction, String outcome) {
return getWrapped().getNavigationCase(context, fromAction, outcome);
}
@Override
public Map> 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);
}
}