org.glassfish.jersey.server.mvc

Class Viewable

java.lang.Object

org.glassfish.jersey.server.mvc.Viewable

Direct Known Subclasses:

ResolvedViewable

public class Viewable
extends Object

A viewable type referencing a template by name and a model to be passed to the template. Such a type may be returned by a resource method of a resource class. In this respect the template is the view and the controller is the resource class in the Model View Controller pattern.

The template name may be declared as absolute template name if the name begins with a '/', otherwise the template name is declared as a relative template name.

A relative template name requires resolving to an absolute template name when the viewable type is processed.
If a resolving class is present then that class may be used to resolve the relative template name.
If a resolving class is not present and resolving class is not defined by the Template annotation then the class of the last matching resource should be utilized as the resolving class.
If there are no matching resources then an error will result.

ViewableContext is responsible for resolving absolute template name from relative template name.

Author:

Paul Sandoz (paul.sandoz at oracle.com), Michal Gajdos (michal.gajdos at oracle.com)

See Also:

Template, ViewableContext, ResolvingViewableContext

Constructor Summary

Constructors

Constructor and Description
Viewable(String templateName) Construct a new viewable type with a template name.
Viewable(String templateName, Object model) Construct a new viewable type with a template name and a model.
Viewable(String templateName, Object model, Class<?> resolvingClass) Construct a new viewable type with a template name, a model and a resolving class.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getModel() Get the model.
Class<?>	getResolvingClass() Get the resolving class.
String	getTemplateName() Get the template name.
boolean	isTemplateNameAbsolute() Determines whether the template name is represented by an absolute path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Viewable

public Viewable(String templateName)
         throws IllegalArgumentException

Construct a new viewable type with a template name.

The model will be set to null.

Parameters:

templateName - the template name, shall not be null.

Throws:

IllegalArgumentException - if the template name is null.

Viewable

public Viewable(String templateName,
        Object model)
         throws IllegalArgumentException

Construct a new viewable type with a template name and a model.

Parameters:

templateName - the template name, shall not be null.

model - the model, may be null.

Throws:

IllegalArgumentException - if the template name is null.

Viewable

public Viewable(String templateName,
        Object model,
        Class<?> resolvingClass)
         throws IllegalArgumentException

Construct a new viewable type with a template name, a model and a resolving class.

Parameters:

templateName - the template name, shall not be null.

model - the model, may be null.

resolvingClass - the class to use to resolve the template name if the template is not absolute, if null then the resolving class will be obtained from the last matching resource.

Throws:

IllegalArgumentException - if the template name is null.

Method Detail

getTemplateName

public String getTemplateName()

Get the template name.

Returns:

the template name.

getModel

public Object getModel()

Get the model.

Returns:

the model.

getResolvingClass

public Class<?> getResolvingClass()

Get the resolving class.

Returns:

the resolving class.

isTemplateNameAbsolute

public boolean isTemplateNameAbsolute()

Determines whether the template name is represented by an absolute path.

Returns:

true if the template name is absolute, and starts with a '/' character, false otherwise.