Package org.glassfish.jersey.server.mvc.internal

Class TemplateHelper

java.lang.Object

org.glassfish.jersey.server.mvc.internal.TemplateHelper

public final class TemplateHelper
extends Object

Helper class to provide some common functionality related to MVC.

Author:

Michal Gajdos

Method Summary

Modifier and Type	Method	Description
static String	getAbsolutePath(Class<?> resourceClass, String path, char delim)	Return an absolute path to the given class where segments are separated using delim character and path is appended to this path.
static List<MediaType>	getProducibleMediaTypes(ContainerRequest containerRequest, ExtendedUriInfo extendedUriInfo, Ref<String> varyHeaderValue)	Get media types for which the resolved viewable could be produced.
static Template	getTemplateAnnotation(Annotation[] annotations)	Extract template annotation from given list.
static String	getTemplateName(Viewable viewable)	Get template name from given viewable or return index if the given viewable doesn't contain a valid template name.
static Charset	getTemplateOutputEncoding(Configuration configuration, String suffix)	Get output encoding from configuration.

Methods inherited from class java.lang.Object

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

Method Details

getAbsolutePath

public static String getAbsolutePath(Class<?> resourceClass,
 String path,
 char delim)

Return an absolute path to the given class where segments are separated using delim character and path is appended to this path.

Parameters:

resourceClass - class for which an absolute path should be obtained.

path - segment to be appended to the resulting path.

delim - character used for separating path segments.

Returns:

an absolute path to the resource class.

getProducibleMediaTypes

public static List<MediaType> getProducibleMediaTypes(ContainerRequest containerRequest,
 ExtendedUriInfo extendedUriInfo,
 Ref<String> varyHeaderValue)

Get media types for which the resolved viewable could be produced.

Parameters:

containerRequest - request to obtain acceptable media types.

extendedUriInfo - uri info to obtain resource method from and its producible media types.

varyHeaderValue - Vary header reference.

Returns:

list of producible media types.

getTemplateName

public static String getTemplateName(Viewable viewable)

Get template name from given viewable or return index if the given viewable doesn't contain a valid template name.

Parameters:

viewable - viewable to obtain template name from.

Returns:

non-null, non-empty template name.

getTemplateAnnotation

public static Template getTemplateAnnotation(Annotation[] annotations)

Extract template annotation from given list.

Parameters:

annotations - list of annotations.

Returns:

template annotation or null if this annotation is not present.

getTemplateOutputEncoding

public static Charset getTemplateOutputEncoding(Configuration configuration,
 String suffix)

Get output encoding from configuration.

Parameters:

configuration - Configuration.

suffix - Template processor suffix of the to configuration property MvcFeature.ENCODING.

Returns:

Encoding read from configuration properties or a default encoding if no encoding is configured.