jakarta.faces.context.FlashWrapper Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.context;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import jakarta.faces.FacesWrapper;
/**
*
* Provides a simple implementation of {@link Flash} that can be subclassed by
* developers wishing to provide specialized behavior to an existing {@link Flash} instance. The default implementation
* of all methods is to call through to the wrapped {@link Flash}.
*
*
*
* 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 FlashWrapper extends Flash implements FacesWrapper {
private Flash wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public FlashWrapper() {
}
/**
*
* If this flash 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 FlashWrapper(Flash wrapped) {
this.wrapped = wrapped;
}
@Override
public Flash getWrapped() {
return wrapped;
}
/**
*
* The default behavior of this method is to call {@link Flash#doPostPhaseActions(FacesContext)} on the wrapped
* {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public void doPostPhaseActions(FacesContext ctx) {
getWrapped().doPostPhaseActions(ctx);
}
/**
*
* The default behavior of this method is to call {@link Flash#doPrePhaseActions(FacesContext)} on the wrapped
* {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public void doPrePhaseActions(FacesContext ctx) {
getWrapped().doPrePhaseActions(ctx);
}
/**
*
* The default behavior of this method is to call {@link Flash#isKeepMessages()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public boolean isKeepMessages() {
return getWrapped().isKeepMessages();
}
/**
*
* The default behavior of this method is to call {@link Flash#isRedirect()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public boolean isRedirect() {
return getWrapped().isRedirect();
}
/**
*
* The default behavior of this method is to call {@link Flash#keep(String)} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public void keep(String key) {
getWrapped().keep(key);
}
/**
*
* The default behavior of this method is to call {@link Flash#putNow(String, Object)} on the wrapped {@link Flash}
* object.
*
*
* @since 2.2
*/
@Override
public void putNow(String key, Object value) {
getWrapped().putNow(key, value);
}
/**
*
* The default behavior of this method is to call {@link Flash#setKeepMessages(boolean)} on the wrapped {@link Flash}
* object.
*
*
* @since 2.2
*/
@Override
public void setKeepMessages(boolean newValue) {
getWrapped().setKeepMessages(newValue);
}
/**
*
* The default behavior of this method is to call {@link Flash#setRedirect(boolean)} on the wrapped {@link Flash}
* object.
*
*
* @since 2.2
*/
@Override
public void setRedirect(boolean newValue) {
getWrapped().setRedirect(newValue);
}
/**
*
* The default behavior of this method is to call {@link Flash#clear()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public void clear() {
getWrapped().clear();
}
/**
*
* The default behavior of this method is to call {@link Flash#containsKey(Object)} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public boolean containsKey(Object key) {
return getWrapped().containsKey(key);
}
/**
*
* The default behavior of this method is to call {@link Flash#containsValue(Object)} on the wrapped {@link Flash}
* object.
*
*
* @since 2.2
*/
@Override
public boolean containsValue(Object value) {
return getWrapped().containsValue(value);
}
/**
*
* The default behavior of this method is to call {@link Flash#entrySet()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Set> entrySet() {
return getWrapped().entrySet();
}
/**
*
* The default behavior of this method is to call {@link Flash#get(Object)} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Object get(Object key) {
return getWrapped().get(key);
}
/**
*
* The default behavior of this method is to call {@link Flash#isEmpty()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public boolean isEmpty() {
return getWrapped().isEmpty();
}
/**
*
* The default behavior of this method is to call {@link Flash#keySet()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Set keySet() {
return getWrapped().keySet();
}
/**
*
* The default behavior of this method is to call {@link Flash#put} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Object put(String key, Object value) {
return getWrapped().put(key, value);
}
/**
*
* The default behavior of this method is to call {@link Flash#putAll(Map)} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public void putAll(Map m) {
getWrapped().putAll(m);
}
/**
*
* The default behavior of this method is to call {@link Flash#remove(Object)} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Object remove(Object key) {
return getWrapped().remove(key);
}
/**
*
* The default behavior of this method is to call {@link Flash#size()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public int size() {
return getWrapped().size();
}
/**
*
* The default behavior of this method is to call {@link Flash#values()} on the wrapped {@link Flash} object.
*
*
* @since 2.2
*/
@Override
public Collection