com.atlassian.jira.web.pagebuilder

Class DefaultPageBuilder

java.lang.Object

com.atlassian.jira.web.pagebuilder.DefaultPageBuilder

All Implemented Interfaces:

PageBuilder, PageBuilderSpi

public class DefaultPageBuilder
extends Object
implements PageBuilder, PageBuilderSpi

Implementation of PageBuilder and PageBuilderSpi interfaces

Since:

v6.1

Constructor Summary

Constructors

Constructor and Description
DefaultPageBuilder(ApplicationProperties applicationProperties, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DecoratorListener decoratorListener, javax.servlet.ServletContext servletContext, FeatureManager featureManager, ServerMetricsDetailCollector serverMetricsDetailCollector)

Method Summary

Modifier and Type	Method and Description
void	finish(DecoratablePage page) Finishes writing the decorated page and decorator to the current HTTP response
void	flush() Flushes as much information as possible to the current HTTP response.
void	setDecorator(Decorator decorator) Sets the decorated page.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPageBuilder

public DefaultPageBuilder(ApplicationProperties applicationProperties,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          DecoratorListener decoratorListener,
                          javax.servlet.ServletContext servletContext,
                          FeatureManager featureManager,
                          ServerMetricsDetailCollector serverMetricsDetailCollector)

Method Detail

setDecorator

public void setDecorator(Decorator decorator)

Description copied from interface: PageBuilder

Sets the decorated page. This can be called any number of times before the first call to flush.

Specified by:

setDecorator in interface PageBuilder

Parameters:

decorator - Decorator for the current request.

flush

public void flush()

Description copied from interface: PageBuilder

Flushes as much information as possible to the current HTTP response. This may be called multiple times in a single request.

Specified by:

flush in interface PageBuilder

finish

public void finish(DecoratablePage page)

Description copied from interface: PageBuilderSpi

Finishes writing the decorated page and decorator to the current HTTP response

Specified by:

finish in interface PageBuilderSpi

Parameters:

page - page being decorated