javax.mvc

Class Viewable

java.lang.Object

javax.mvc.Viewable

public class Viewable
extends Object

An abstraction that encapsulates information about a view as well as an instance of Models and a ViewEngine class, in which only the view information is mandatory. Instances of this class can be returned by controller methods.

If no Models is specified, the view engine is required to inject it; if no ViewEngine is specified, then the default selection mechanism that associates views with view engines must be used. It follows that a controller method returning an instance of this class can override the Models in request scope as well as the default lookup mechanism for view engines.

Since:

1.0

Author:

Santiago Pericas-Geertsen

See Also:

Models, Controller, ViewEngine

Constructor Summary

Constructors

Constructor and Description
Viewable(String view) Constructs an instance specifying only a view.
Viewable(String view, Class<? extends ViewEngine> viewEngine) Constructs an instance using a view and a view engine.
Viewable(String view, Models models) Constructs an instance using a view and a models instance.
Viewable(String view, Models models, Class<? extends ViewEngine> viewEngine) Constructs an instance using a view, a models and a view engine instances.

Method Summary

Modifier and Type	Method and Description
Models	getModels() Get the models instance.
String	getView() Get the view.
Class<? extends ViewEngine>	getViewEngine() Get the view engine instance.
void	setModels(Models models) Set the models instance.
void	setView(String view) Set a new view.
void	setViewEngine(Class<? extends ViewEngine> viewEngine) Set the view engine instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Viewable

public Viewable(String view)

Constructs an instance specifying only a view.

Parameters:

view - the view.

Viewable

public Viewable(String view,
                Class<? extends ViewEngine> viewEngine)

Constructs an instance using a view and a view engine.

Parameters:

view - the view.

viewEngine - the view engine class.

Viewable

public Viewable(String view,
                Models models)

Constructs an instance using a view and a models instance.

Parameters:

view - the view.

models - the models instance.

Viewable

public Viewable(String view,
                Models models,
                Class<? extends ViewEngine> viewEngine)

Constructs an instance using a view, a models and a view engine instances.

Parameters:

view - the view.

models - the models instance.

viewEngine - the view engine class.

Method Detail

getView

public String getView()

Get the view.

Returns:

the view.

setView

public void setView(String view)

Set a new view.

Parameters:

view - the new view.

getModels

public Models getModels()

Get the models instance.

Returns:

the models instance or null.

setModels

public void setModels(Models models)

Set the models instance.

Parameters:

models - the new models instance.

getViewEngine

public Class<? extends ViewEngine> getViewEngine()

Get the view engine instance.

Returns:

the view engine instance or null.

setViewEngine

public void setViewEngine(Class<? extends ViewEngine> viewEngine)

Set the view engine instance.

Parameters:

viewEngine - the new view engine instance.