javax.faces.event.ScopeContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.3_spec Show documentation
Show all versions of jboss-jsf-api_2.3_spec Show documentation
JSR-000372: JavaServer(TM) Faces 2.3 API
/*
* Copyright (c) 1997, 2018 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 javax.faces.event;
import java.util.Map;
/**
* A structure that contains the name of
* the scope and the scope itself exposed as a Map<String,
* Object>.
*
* @since 2.0
*/
public class ScopeContext {
private String scopeName;
private Map scope;
// ------------------------------------------------------------ Constructors
/**
* Construct this structure with the
* supplied arguments.
* @param scopeName the name of the scope
* @param scope the scope itself
*/
public ScopeContext(String scopeName, Map scope) {
this.scopeName = scopeName;
this.scope = scope;
}
// ---------------------------------------------------------- Public Methods
/**
* Return the name of this custom
* scope.
*
* @return Return the name of this custom scope.
*/
public String getScopeName() {
return scopeName;
}
/**
* Return the scope itself, exposed
* as a Map.
*
* @return Return the scope itself, exposed as a Map
*/
public Map getScope() {
return scope;
}
}