Index (Shredzone Commons: View 1.4 API)

A B C D E G H I M N O P Q R S T V
All Classes All Packages

A

ABSOLUTE - org.shredzone.commons.view.PathType: Absolute URL (e.g.
AbstractPathContext - Class in org.shredzone.commons.view: An abstract implementation of PathContext.
AbstractPathContext() - Constructor for class org.shredzone.commons.view.AbstractPathContext
addProperty(String) - Method in class org.shredzone.commons.view.AbstractPathContext: Adds a property name to the signature.
Attribute - Annotation Type in org.shredzone.commons.view.annotation: If a view handler parameter is annotated with Attribute, the servlet attribute with the given name passed in.

B

buildPath(PathContext, String, PathType) - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
buildPath(PathContext, String, PathType) - Method in interface org.shredzone.commons.view.ViewService: Builds an URL path to a view that is able to render the provided data.

C

compareTo(ViewPattern) - Method in class org.shredzone.commons.view.manager.ViewPattern
Cookie - Annotation Type in org.shredzone.commons.view.annotation: Annotates a parameter of the view handler.
createEvaluationContext(PathContext) - Method in class org.shredzone.commons.view.impl.ViewServiceImpl: Creates an EvaluationContext to be used for evaluation in this view service.

D

decode(String) - Static method in class org.shredzone.commons.view.util.PathUtils: URL decodes a string.
doService(HttpServletRequest, HttpServletResponse) - Method in class org.shredzone.commons.view.servlet.ViewServlet

E

EmptyViewInterceptor - Class in org.shredzone.commons.view: A ViewInterceptor that does nothing.
EmptyViewInterceptor() - Constructor for class org.shredzone.commons.view.EmptyViewInterceptor
encode(String) - Static method in class org.shredzone.commons.view.util.PathUtils: URL encodes a string.
equals(Object) - Method in class org.shredzone.commons.view.manager.ViewPattern
equals(Object) - Method in class org.shredzone.commons.view.Signature
ErrorResponseException - Exception in org.shredzone.commons.view.exception: This exception is thrown when a generic HTTP error happened.
ErrorResponseException(int) - Constructor for exception org.shredzone.commons.view.exception.ErrorResponseException: Creates a new ErrorResponseException.
ErrorResponseException(int, String) - Constructor for exception org.shredzone.commons.view.exception.ErrorResponseException: Creates a new ErrorResponseException.
evaluate(EvaluationContext, PathContext) - Method in class org.shredzone.commons.view.manager.ViewPattern: Evaluates the given EvaluationContext and builds an URL to the appropriate view.

G

getBean() - Method in class org.shredzone.commons.view.manager.ViewInvoker: The Spring bean that was annotated with ViewHandler.
getExpression() - Method in class org.shredzone.commons.view.manager.ViewPattern: Returns an Expression for each placeholder in the pattern.
getInvoker() - Method in class org.shredzone.commons.view.manager.ViewPattern: Gets the ViewInvoker to be used for rendering.
getJspPath(ServletConfig) - Method in class org.shredzone.commons.view.servlet.ViewServlet: Gets the JSP path from the servlet configuration.
getMethod() - Method in class org.shredzone.commons.view.manager.ViewInvoker: The target view handler method that was annotated with View.
getParameter(String) - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getParameter(String) - Method in interface org.shredzone.commons.view.ViewContext: Gets a parameter from the request URL's search part.
getParameters() - Method in class org.shredzone.commons.view.manager.ViewPattern: Returns a list of parameter strings for each placeholder in the pattern.
getPathParts() - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getPathParts() - Method in interface org.shredzone.commons.view.ViewContext: Gets a map of all path parts.
getPattern() - Method in class org.shredzone.commons.view.manager.ViewPattern: Gets the view's URL pattern.
getQualifier() - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getQualifier() - Method in class org.shredzone.commons.view.manager.ViewPattern: Returns the qualifier of this pattern.
getQualifier() - Method in interface org.shredzone.commons.view.PathContext: Gets the qualifier to be used.
getQualifier() - Method in interface org.shredzone.commons.view.ViewContext: Gets a View qualifier.
getRegEx() - Method in class org.shredzone.commons.view.manager.ViewPattern: Gets a regular expression Pattern to match a URL against this ViewPattern.
getRequestServerUrl() - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getRequestServerUrl() - Method in interface org.shredzone.commons.view.ViewContext: Returns the server URL the request was sent to.
getRequestServletName() - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getRequestServletName() - Method in interface org.shredzone.commons.view.ViewContext: Returns the name of the servlet that processed the request.
getResponseCode() - Method in exception org.shredzone.commons.view.exception.ErrorResponseException
getSignature() - Method in class org.shredzone.commons.view.AbstractPathContext
getSignature() - Method in class org.shredzone.commons.view.manager.ViewPattern: Gets the signature stored in this ViewPattern.
getSignature() - Method in interface org.shredzone.commons.view.PathContext: Gets a Signature for this PathContext.
getTemplatePath(String) - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
getTemplatePath(String) - Method in interface org.shredzone.commons.view.ViewService: Gets the path to a template resource with the given name.
getValueOfType(Class<T>) - Method in class org.shredzone.commons.view.impl.ViewContextImpl
getValueOfType(Class<T>) - Method in interface org.shredzone.commons.view.ViewContext: Gets a value that matches the requested type.
getVariables() - Method in class org.shredzone.commons.view.AbstractPathContext
getVariables() - Method in interface org.shredzone.commons.view.PathContext: Gets a map of variables to be used.
getViewContext() - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
getViewContext() - Method in interface org.shredzone.commons.view.ViewService: Gets the ViewContext of the current request.
getViewPatternForSignature(Signature, String) - Method in class org.shredzone.commons.view.manager.ViewManager: Returns the ViewPattern that handles the given Signature.
getViewPatterns() - Method in class org.shredzone.commons.view.manager.ViewManager: Returns a collection of all defined ViewPattern.
getViewPatternsForView(String, String) - Method in class org.shredzone.commons.view.manager.ViewManager: Returns a collection of ViewPattern that were defined for the given view.
getWeight() - Method in class org.shredzone.commons.view.manager.ViewPattern: Gets the weight of this ViewPattern.

H

handleRequest(HttpServletRequest, HttpServletResponse) - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
handleRequest(HttpServletRequest, HttpServletResponse) - Method in interface org.shredzone.commons.view.ViewService: Handles a HTTP request.
hashCode() - Method in class org.shredzone.commons.view.manager.ViewPattern
hashCode() - Method in class org.shredzone.commons.view.Signature

I

init() - Method in class org.shredzone.commons.view.util.ViewPathEvaluationContext: Initializes the evaluation context.
init(ServletConfig) - Method in class org.shredzone.commons.view.servlet.ViewServlet
invoke(ViewContext) - Method in class org.shredzone.commons.view.manager.ViewInvoker: Invokes the view handler.
invokeView(String) - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
invokeView(String) - Method in interface org.shredzone.commons.view.ViewService: Analyzes the given path, and invokes a view handler for processing the request.

M

matches(String) - Method in class org.shredzone.commons.view.manager.ViewPattern: Matches the requested URL against this ViewPattern.

N

name() - Method in annotation type org.shredzone.commons.view.annotation.View: View name.

O

onErrorResponse(ErrorResponseException, HttpServletRequest, HttpServletResponse) - Method in class org.shredzone.commons.view.EmptyViewInterceptor
onErrorResponse(ErrorResponseException, HttpServletRequest, HttpServletResponse) - Method in interface org.shredzone.commons.view.ViewInterceptor: Called when an ErrorResponseException occured.
onRendering(String, HttpServletRequest, HttpServletResponse) - Method in class org.shredzone.commons.view.EmptyViewInterceptor
onRendering(String, HttpServletRequest, HttpServletResponse) - Method in interface org.shredzone.commons.view.ViewInterceptor: Called when a ViewHandler successfully processed the request and returned a template string that is now to be rendered.
onRequest(HttpServletRequest, HttpServletResponse) - Method in class org.shredzone.commons.view.EmptyViewInterceptor
onRequest(HttpServletRequest, HttpServletResponse) - Method in interface org.shredzone.commons.view.ViewInterceptor: Called when a HTTP request was sent to the view service.
onViewHandlerInvocation(ViewContext, Object, Method) - Method in class org.shredzone.commons.view.EmptyViewInterceptor
onViewHandlerInvocation(ViewContext, Object, Method) - Method in interface org.shredzone.commons.view.ViewInterceptor: Called when a ViewHandler is about to be invoked.
Optional - Annotation Type in org.shredzone.commons.view.annotation: If a view handler parameter is annotated with Optional, it also accepts null if there is no matching parameter value.
org.shredzone.commons.view - package org.shredzone.commons.view
org.shredzone.commons.view.annotation - package org.shredzone.commons.view.annotation
org.shredzone.commons.view.exception - package org.shredzone.commons.view.exception
org.shredzone.commons.view.impl - package org.shredzone.commons.view.impl
org.shredzone.commons.view.manager - package org.shredzone.commons.view.manager
org.shredzone.commons.view.servlet - package org.shredzone.commons.view.servlet
org.shredzone.commons.view.util - package org.shredzone.commons.view.util

P

PageNotFoundException - Exception in org.shredzone.commons.view.exception: This exception is thrown when an error happened because there is no view defined for the requested URL.
PageNotFoundException() - Constructor for exception org.shredzone.commons.view.exception.PageNotFoundException: Creates a new PageNotFoundException.
PageNotFoundException(String) - Constructor for exception org.shredzone.commons.view.exception.PageNotFoundException: Creates a new PageNotFoundException with a message.
Parameter - Annotation Type in org.shredzone.commons.view.annotation: Annotates a parameter of the view handler.
PathContext - Interface in org.shredzone.commons.view: Context that holds all data required for building a path.
PathPart - Annotation Type in org.shredzone.commons.view.annotation: Annotates a view handler method parameter.
PathType - Enum in org.shredzone.commons.view: Enumeration of path types that can be built.
PathUtils - Class in org.shredzone.commons.view.util: Utility methods for view path management.
pattern() - Method in annotation type org.shredzone.commons.view.annotation.View: View pattern.
putTypedArgument(Class<T>, T) - Method in class org.shredzone.commons.view.impl.ViewContextImpl
putTypedArgument(Class<T>, T) - Method in interface org.shredzone.commons.view.ViewContext: Adds a typed argument to this context.

Q

qualifier() - Method in annotation type org.shredzone.commons.view.annotation.View: View handler qualifier.
Qualifier - Annotation Type in org.shredzone.commons.view.annotation: Annotates a String parameter of the view handler.

R

RELATIVE - org.shredzone.commons.view.PathType: Relative URL (e.g.
resolve(String) - Method in class org.shredzone.commons.view.manager.ViewPattern: Resolves a requested URL path.

S

SessionId - Annotation Type in org.shredzone.commons.view.annotation: Annotates a String parameter that will contain an unique identifier for the current HTTP session, or null if there is no session.
setPathParts(Map<String, String>) - Method in class org.shredzone.commons.view.impl.ViewContextImpl
setPathParts(Map<String, String>) - Method in interface org.shredzone.commons.view.ViewContext: Sets the path parts from resolving the view URL.
setQualifier(String) - Method in class org.shredzone.commons.view.impl.ViewContextImpl
setQualifier(String) - Method in interface org.shredzone.commons.view.ViewContext: Sets a View qualifier.
setup() - Method in class org.shredzone.commons.view.impl.ViewContextImpl: Sets up this bean's contents.
setup() - Method in class org.shredzone.commons.view.impl.ViewServiceImpl
setup() - Method in class org.shredzone.commons.view.manager.ViewManager: Sets up the view manager.
setVariable(String, Object) - Method in class org.shredzone.commons.view.AbstractPathContext: Sets a variable.
signature() - Method in annotation type org.shredzone.commons.view.annotation.View: View signature.
Signature - Class in org.shredzone.commons.view: A signature is a hash key for a set of String elements.
Signature(String[]) - Constructor for class org.shredzone.commons.view.Signature: Instantiates a new signature.
Signature(Collection<String>) - Constructor for class org.shredzone.commons.view.Signature: Instantiates a new signature.
simplify(String) - Static method in class org.shredzone.commons.view.util.PathUtils: Simplifies a path part.
suffix(String) - Static method in class org.shredzone.commons.view.util.PathUtils: Suggests a file name suffix for the given content type.

T

toString() - Method in class org.shredzone.commons.view.Signature

V

value() - Method in annotation type org.shredzone.commons.view.annotation.Attribute: Name of the attribute.
value() - Method in annotation type org.shredzone.commons.view.annotation.Cookie: Name of the cookie
value() - Method in annotation type org.shredzone.commons.view.annotation.Parameter: Name of the URL's query parameter.
value() - Method in annotation type org.shredzone.commons.view.annotation.PathPart: Name of the pattern placeholder.
value() - Method in annotation type org.shredzone.commons.view.annotation.ViewGroup: Collection of View annotations
valueOf(String) - Static method in enum org.shredzone.commons.view.PathType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.shredzone.commons.view.PathType: Returns an array containing the constants of this enum type, in the order they are declared.
View - Annotation Type in org.shredzone.commons.view.annotation: A view handler method is annotated with View.
VIEW - org.shredzone.commons.view.PathType: Relative to the view servlet (e.g.
ViewContext - Interface in org.shredzone.commons.view: Provides a context of the View that is to be rendered in this request.
ViewContextException - Exception in org.shredzone.commons.view.exception: This exception is thrown when an error happened because ViewContext was unable to return the requested data.
ViewContextException() - Constructor for exception org.shredzone.commons.view.exception.ViewContextException: Creates a new ViewContextException.
ViewContextException(String) - Constructor for exception org.shredzone.commons.view.exception.ViewContextException: Creates a new ViewContextException.
ViewContextException(String, Throwable) - Constructor for exception org.shredzone.commons.view.exception.ViewContextException: Creates a new ViewContextException.
ViewContextException(Throwable) - Constructor for exception org.shredzone.commons.view.exception.ViewContextException: Creates a new ViewContextException.
ViewContextImpl - Class in org.shredzone.commons.view.impl: Default implementation of ViewContext.
ViewContextImpl() - Constructor for class org.shredzone.commons.view.impl.ViewContextImpl
ViewException - Exception in org.shredzone.commons.view.exception: This exception is raised when a view could not be rendered for various reasons.
ViewException() - Constructor for exception org.shredzone.commons.view.exception.ViewException: Creates a new ViewException.
ViewException(String) - Constructor for exception org.shredzone.commons.view.exception.ViewException: Creates a new ViewException.
ViewException(String, Throwable) - Constructor for exception org.shredzone.commons.view.exception.ViewException: Creates a new ViewException.
ViewException(Throwable) - Constructor for exception org.shredzone.commons.view.exception.ViewException: Creates a new ViewException.
ViewGroup - Annotation Type in org.shredzone.commons.view.annotation: A ViewGroup contains multiple View annotations.
ViewHandler - Annotation Type in org.shredzone.commons.view.annotation: Spring beans annotated with ViewHandler contain one or more view handler methods annotated with either View or ViewGroup.
ViewInterceptor - Interface in org.shredzone.commons.view: Spring beans implementing this interface are allowed to inspect or change the output of view handlers.
ViewInvoker - Class in org.shredzone.commons.view.manager: Keeps a reference to and invokes a view handler.
ViewInvoker(Object, Method, ConversionService) - Constructor for class org.shredzone.commons.view.manager.ViewInvoker: Creates a new ViewInvoker.
ViewManager - Class in org.shredzone.commons.view.manager: Manages the view handlers.
ViewManager() - Constructor for class org.shredzone.commons.view.manager.ViewManager
ViewPathEvaluationContext - Class in org.shredzone.commons.view.util: An EvaluationContext that offers additional string functions.
ViewPathEvaluationContext(PathContext) - Constructor for class org.shredzone.commons.view.util.ViewPathEvaluationContext: Instantiates a new view path evaluation context.
ViewPattern - Class in org.shredzone.commons.view.manager: A view pattern is a URL pattern for a view.
ViewPattern(View, ViewInvoker) - Constructor for class org.shredzone.commons.view.manager.ViewPattern: Instantiates a new view pattern.
ViewService - Interface in org.shredzone.commons.view: Service for rendering views, creating links to views, and handling servlet requests.
ViewServiceImpl - Class in org.shredzone.commons.view.impl: Default implementation of ViewService.
ViewServiceImpl() - Constructor for class org.shredzone.commons.view.impl.ViewServiceImpl
ViewServlet - Class in org.shredzone.commons.view.servlet: Main servlet for handling all kind of view requests.
ViewServlet() - Constructor for class org.shredzone.commons.view.servlet.ViewServlet

A B C D E G H I M N O P Q R S T V
All Classes All Packages