javax.mvc.Models Maven / Gradle / Ivy
/*
* Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016-2018 JSR 371 expert group and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.mvc;
import java.util.Map;
/**
* A map of name to model instances used by a {@link javax.mvc.engine.ViewEngine}
* to process a view. Instances implementing this interface must be injectable using
* {@link javax.inject.Inject} and are {@link javax.enterprise.context.RequestScoped}.
*
*
Note that certain view engines, such as engines for JSPs and Facelets, support
* model binding via {@link javax.inject.Named} in which case the use of Models is
* optional.
*
* @author Santiago Pericas-Geertsen
* @author Christian Kaltepoth
* @see javax.inject.Named
* @see javax.enterprise.context.RequestScoped
* @since 1.0
*/
public interface Models extends Iterable {
/**
* Stores a new model in the map.
*
* @param name name of the model
* @param model model to store in the map
* @return the current instance to allow method chaining
*/
Models put(String name, Object model);
/**
* Retrieve a model by name.
*
* @param name name of the model
* @return the model or null
*/
Object get(String name);
/**
* Retrieve a model by name in a type-safe way.
*
* @param name name of the model
* @param clazz type of the model
* @param type of the model
* @return The model or null
*/
T get(String name, Class clazz);
/**
* Returns a unmodifiable view of the models map.
*
* @return unmodifiable map
*/
Map asMap();
}