A B C D E F G H I L M N O P R S T U V W X

A

abortBufferingIfBadStatusCode(int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

activateDestination() - Method in interface org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter.DestinationFactory

addAttribute(String, String) - Method in class org.sitemesh.tagprocessor.CustomTag

Add a new attribute.

addDateHeader(String, long) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

addDecoratorPath(String, String) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Add a decorator path to be used for a specific content path.

addDecoratorPaths(String, String...) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Add multiple decorator paths to be used for a specific content path.

addDecoratorPaths(String, List<String>) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Add multiple decorator paths to be used for a specific content path.

addExcludedPath(String) - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Add a path to be excluded by SiteMesh.

addExclusion(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

This method will add the header name to the list of headers to be filtered.

addHeader(String, String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

addIntHeader(String, int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

addRule(String, TagRule) - Method in class org.sitemesh.tagprocessor.State

Adds a TagRule that will be called for

addRule(String, TagRule) - Method in class org.sitemesh.tagprocessor.TagProcessor

Equivalent of TagProcessor.defaultState().addRule()

addSiteMeshfileset(SiteMeshFileSet) - Method in class org.sitemesh.ant.SiteMeshTask

addTagRuleBundle(TagRuleBundle) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Add a new TagRuleBundle to the TagBasedContentProcessor.

addTagRuleBundles(TagRuleBundle...) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Convenient way to call BaseSiteMeshBuilder.addTagRuleBundle(org.sitemesh.content.tagrules.TagRuleBundle) multiple times.

addTagRuleBundles(Iterable<TagRuleBundle>) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Convenient way to call BaseSiteMeshBuilder.addTagRuleBundle(org.sitemesh.content.tagrules.TagRuleBundle) multiple times.

append(CharSequence) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

append(CharSequence, int, int) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

append(char) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

Warning: Each time this method is called, a new String of length 1 is constructed and added to a LinkedList - this is not optimal.

append(CharSequence) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

append(CharSequence, int, int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

append(char) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

applyCustomConfiguration(SiteMeshOfflineBuilder) - Method in class org.sitemesh.ant.SiteMeshTask

Override this to apply custom configuration after after the default configuration mechanisms.

applyCustomConfiguration(SiteMeshFilterBuilder) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Override this to apply custom configuration after after the default configuration mechanisms.

ArgParser - Class in org.sitemesh.config.cmdline

Simple command line argument parser that extracts a list of key/value properties and remaining arguments.

ArgParser(String...) - Constructor for class org.sitemesh.config.cmdline.ArgParser

attributeCount - Variable in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

attributes - Variable in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

AUTO_RELOAD_DEFAULT - Static variable in class org.sitemesh.config.ConfigurableSiteMeshFilter

AUTO_RELOAD_PARAM - Static variable in class org.sitemesh.config.ConfigurableSiteMeshFilter

B

BaseSiteMeshBuilder<BUILDER extends BaseSiteMeshBuilder,CONTEXT extends SiteMeshContext,RESULT> - Class in org.sitemesh.builder

Common functionality for BaseSiteMeshFilterBuilder and BaseSiteMeshOfflineBuilder.

BaseSiteMeshBuilder() - Constructor for class org.sitemesh.builder.BaseSiteMeshBuilder

BaseSiteMeshContext - Class in org.sitemesh

Common implementation code for SiteMeshContext.

BaseSiteMeshContext(ContentProcessor) - Constructor for class org.sitemesh.BaseSiteMeshContext

BaseSiteMeshFilterBuilder<BUILDER extends BaseSiteMeshBuilder> - Class in org.sitemesh.builder

Functionality for building a SiteMeshFilter.

BaseSiteMeshFilterBuilder() - Constructor for class org.sitemesh.builder.BaseSiteMeshFilterBuilder

BaseSiteMeshOfflineBuilder<BUILDER extends BaseSiteMeshOfflineBuilder> - Class in org.sitemesh.builder

Functionality for building a SiteMeshOffline.

BaseSiteMeshOfflineBuilder() - Constructor for class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

BasicBlockRule<T> - Class in org.sitemesh.tagprocessor

TagRule helper class for dealing with blocks surrounded by an opening and closing tag.

BasicBlockRule() - Constructor for class org.sitemesh.tagprocessor.BasicBlockRule

BasicRule - Class in org.sitemesh.tagprocessor

Basic implementation of TagRule.

BasicRule() - Constructor for class org.sitemesh.tagprocessor.BasicRule

BasicSelector - Class in org.sitemesh.webapp.contentfilter

Basic implementation of Selector.

BasicSelector(String...) - Constructor for class org.sitemesh.webapp.contentfilter.BasicSelector

BasicSelector(PathMapper<Boolean>, String...) - Constructor for class org.sitemesh.webapp.contentfilter.BasicSelector

BasicSelector(boolean, String...) - Constructor for class org.sitemesh.webapp.contentfilter.BasicSelector

BasicSelector(PathMapper<Boolean>, boolean, String...) - Constructor for class org.sitemesh.webapp.contentfilter.BasicSelector

beginNewResponse() - Method in class org.sitemesh.webapp.contentfilter.ResponseMetaData

Buffer - Class in org.sitemesh.webapp.contentfilter.io

A shared buffer, that can provide an interface as either a PrintWriter (through Buffer.getWriter()) or ServletOutputStream (through Buffer.getOutputStream().

Buffer(String) - Constructor for class org.sitemesh.webapp.contentfilter.io.Buffer

bufferAndPostProcess(FilterChain, HttpServletRequest, HttpServletResponse, Selector) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

Apply next filter/servlet to the buffer, post process the response and send to the real response.

bufferingWasDisabled() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

build(CharBuffer, SiteMeshContext) - Method in interface org.sitemesh.content.ContentProcessor

build(CharBuffer, SiteMeshContext) - Method in class org.sitemesh.content.debug.DumpingContentProcessor

build(CharBuffer, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.TagBasedContentProcessor

ByteBufferBuilder - Class in org.sitemesh.webapp.contentfilter.io

A speedy implementation of ByteArrayOutputStream.

ByteBufferBuilder() - Constructor for class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

ByteBufferBuilder(int) - Constructor for class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

C

changeState(State) - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Change the State of the processor, which will result in different TagRules being applied.

charAt(int) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

CharSequenceBuffer - Interface in org.sitemesh.tagprocessor

CharSequenceList - Class in org.sitemesh.tagprocessor.util

An Appendable buffer of character data,similar to StringBuilder and StringBuffer), except rather than copying the contents to an array of characters, it keeps a list of references to the original CharSequences.

CharSequenceList() - Constructor for class org.sitemesh.tagprocessor.util.CharSequenceList

checkError() - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

cleanUp(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.decorate.DecoratorTagRuleBundle

cleanUp(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.CoreHtmlTagRuleBundle

cleanUp(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.DivExtractingTagRuleBundle

cleanUp(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.Sm2TagRuleBundle

cleanUp(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.msoffice.MsOfficeTagRuleBundle

cleanUp(State, ContentProperty, SiteMeshContext) - Method in interface org.sitemesh.content.tagrules.TagRuleBundle

clearTagRuleBundles() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Clear any TagRuleBundles (including those added in BaseSiteMeshBuilder.setupDefaults().

close() - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

close() - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

CommandLineLauncher - Class in org.sitemesh.config.cmdline

Simple command line launcher for SiteMesh Offline website generator.

CommandLineLauncher() - Constructor for class org.sitemesh.config.cmdline.CommandLineLauncher

CONFIG_FILE_DEFAULT - Static variable in class org.sitemesh.config.cmdline.CommandLineLauncher

CONFIG_FILE_DEFAULT - Static variable in class org.sitemesh.config.ConfigurableSiteMeshFilter

CONFIG_FILE_PARAM - Static variable in class org.sitemesh.config.cmdline.CommandLineLauncher

CONFIG_FILE_PARAM - Static variable in class org.sitemesh.config.ConfigurableSiteMeshFilter

ConfigurableSiteMeshFilter - Class in org.sitemesh.config

A SiteMesh filter that can be dropped in to web.xml, that does not require having to write any Java code.

ConfigurableSiteMeshFilter() - Constructor for class org.sitemesh.config.ConfigurableSiteMeshFilter

configureCommon(BaseSiteMeshBuilder) - Method in class org.sitemesh.config.properties.PropertiesConfigurator

configureCommon(BaseSiteMeshBuilder) - Method in class org.sitemesh.config.xml.XmlConfigurator

configureFilter(BaseSiteMeshFilterBuilder) - Method in class org.sitemesh.config.properties.PropertiesFilterConfigurator

configureFilter(BaseSiteMeshFilterBuilder) - Method in class org.sitemesh.config.xml.XmlFilterConfigurator

configureOffline(BaseSiteMeshOfflineBuilder) - Method in class org.sitemesh.config.properties.PropertiesOfflineConfigurator

configureOffline(BaseSiteMeshOfflineBuilder) - Method in class org.sitemesh.config.xml.XmlOfflineConfigurator

ContainerTweaks - Class in org.sitemesh.webapp.contentfilter

Provides details of Servlet container tweaks to apply - necessary because containers behave subtly different.

ContainerTweaks() - Constructor for class org.sitemesh.webapp.contentfilter.ContainerTweaks

ContainerTweaks.TomcatTweaks - Class in org.sitemesh.webapp.contentfilter

Container tweaks specific to Tomcat.

ContainerTweaks.TomcatTweaks() - Constructor for class org.sitemesh.webapp.contentfilter.ContainerTweaks.TomcatTweaks

ContainerTweaks.WebLogicTweaks - Class in org.sitemesh.webapp.contentfilter

Container tweaks specific to WebLogic.

ContainerTweaks.WebLogicTweaks() - Constructor for class org.sitemesh.webapp.contentfilter.ContainerTweaks.WebLogicTweaks

Content - Interface in org.sitemesh.content

CONTENT_KEY - Static variable in class org.sitemesh.webapp.WebAppContext

Key that the ContentProperty is stored under in the HttpServletRequest attribute.

CONTENT_PROCESSOR_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesConfigurator

ContentBlockExtractingRule - Class in org.sitemesh.content.tagrules.html

Extracts the contents of any elements that look like <content tag='foo'>...</content> and write the contents to a page property (page.foo).

ContentBlockExtractingRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.ContentBlockExtractingRule

ContentBufferingFilter - Class in org.sitemesh.webapp.contentfilter

Abstract Filter implementation that writes the main content of a response to a temporary buffer where it can then be post-processed before being served.

ContentBufferingFilter(Selector) - Constructor for class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

ContentChunk - Interface in org.sitemesh.content

A mutable reference to a chunk of content.

ContentProcessor - Interface in org.sitemesh.content

ContentProperty - Interface in org.sitemesh.content

CONTEXT_KEY - Static variable in class org.sitemesh.webapp.WebAppContext

Key that the WebAppContext is stored under in the HttpServletRequest attribute.

copy(String, Directory, String) - Method in interface org.sitemesh.offline.directory.Directory

Copy a file from this directory to another location.

copy(String, Directory, String) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

copy(String, Directory, String) - Method in class org.sitemesh.offline.directory.InMemoryDirectory

CoreHtmlTagRuleBundle - Class in org.sitemesh.content.tagrules.html

ContentProcessor implementation that processes HTML documents.

CoreHtmlTagRuleBundle() - Constructor for class org.sitemesh.content.tagrules.html.CoreHtmlTagRuleBundle

create() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

create() - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Create the SiteMesh Filter.

create() - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Create the SiteMeshOfflineGenerator.

create() - Method in class org.sitemesh.builder.SiteMeshFilterBuilder

Create the SiteMesh Filter.

create() - Method in class org.sitemesh.builder.SiteMeshOfflineBuilder

Create the SiteMeshOfflineGenerator.

create(String) - Method in interface org.sitemesh.config.ObjectFactory

create(String) - Method in class org.sitemesh.config.ObjectFactory.Default

create() - Method in interface org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream.DestinationFactory

createContext(String, HttpServletRequest, HttpServletResponse, ResponseMetaData) - Method in class org.sitemesh.webapp.SiteMeshFilter

Create a context for the current request.

createDataOnlyBuffer() - Method in interface org.sitemesh.content.Content

Creates a buffer that will output it contents in Content.getData(), but NOT in the extracted properties from Content.getExtractedProperties().

createDataOnlyBuffer() - Method in class org.sitemesh.content.memory.InMemoryContent

createSiteMeshOffline(FileSet) - Method in class org.sitemesh.ant.SiteMeshTask

Creates The SiteMeshOffline generator for the given FileSet.

currentBuffer() - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Get the current destination output buffer.

currentBufferContents() - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Get the contents of the current destination output buffer.

currentState() - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Return the current State the processor is in.

CustomTag - Class in org.sitemesh.tagprocessor

A CustomTag provides a mechanism to manipulate the contents of a Tag.

CustomTag(String, Tag.Type) - Constructor for class org.sitemesh.tagprocessor.CustomTag

Create new tag.

CustomTag(Tag) - Constructor for class org.sitemesh.tagprocessor.CustomTag

Create a CustomTag based on an existing Tag - this takes a copy of the Tag.

D

decorate(String, Content, Writer) - Method in class org.sitemesh.BaseSiteMeshContext

decorate(String, Content) - Method in class org.sitemesh.BaseSiteMeshContext

decorate(String, Content, Writer) - Method in class org.sitemesh.offline.OfflineContext

decorate(String, Content) - Method in interface org.sitemesh.SiteMeshContext

decorate(String, Content, Writer) - Method in class org.sitemesh.webapp.WebAppContext

Dispatches to another path to render a decorator.

DECORATOR_MAPPINGS_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesConfigurator

DECORATOR_SELECTOR - Static variable in class org.sitemesh.config.properties.PropertiesFilterConfigurator

DecoratorSelector<C extends SiteMeshContext> - Interface in org.sitemesh

Selects an appropriate decorator path based on the content and context.

DecoratorTagRuleBundle - Class in org.sitemesh.content.tagrules.decorate

TagRuleBundle for custom SiteMesh tags used for building/applying decorators.

DecoratorTagRuleBundle() - Constructor for class org.sitemesh.content.tagrules.decorate.DecoratorTagRuleBundle

DEFAULT_KEYS - Static variable in class org.sitemesh.config.PathMapper

defaultState() - Method in class org.sitemesh.tagprocessor.TagProcessor

The default state of the processor (that is, when it begins processing).

deployNewFilter(Filter) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

DEST_DIR_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesOfflineConfigurator

destroy() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

destroy() - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

Directory - Interface in org.sitemesh.offline.directory

Abstraction over a directory of files.

disableBuffering() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Disable buffering for this request.

dispatch(HttpServletRequest, HttpServletResponse, String) - Method in class org.sitemesh.webapp.WebAppContext

Dispatch to the actual path.

DivExtractingRule - Class in org.sitemesh.content.tagrules.html

DivExtractingRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.DivExtractingRule

DivExtractingTagRuleBundle - Class in org.sitemesh.content.tagrules.html

TagRuleBundle that exports all <div> elements as properties.

DivExtractingTagRuleBundle() - Constructor for class org.sitemesh.content.tagrules.html.DivExtractingTagRuleBundle

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.sitemesh.webapp.SiteMeshFilter

dump(Content, Appendable) - Static method in class org.sitemesh.content.debug.DumpingContentProcessor

dump(Content) - Static method in class org.sitemesh.content.debug.DumpingContentProcessor

DumpingContentProcessor - Class in org.sitemesh.content.debug

Decorates a ContentProcessor and will dump the contents of each Content that is created to an output stream.

DumpingContentProcessor(ContentProcessor, Appendable) - Constructor for class org.sitemesh.content.debug.DumpingContentProcessor

E

enableBuffering(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Enable buffering for this request.

encode(ByteBuffer, String) - Static method in class org.sitemesh.webapp.contentfilter.io.TextEncoder

equals(Object) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

equals(Object) - Method in class org.sitemesh.tagprocessor.CustomTag

EXCLUDE_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesFilterConfigurator

excludePatternInUse(HttpServletRequest) - Method in class org.sitemesh.webapp.contentfilter.BasicSelector

excludePatternInUse(HttpServletRequest) - Method in interface org.sitemesh.webapp.contentfilter.Selector

Return pattern used for excluding request path if the path is excluded or null.

exclusionsHeaders - Variable in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

The HTTP Headers that will be removed when filtering is enabled.

execute() - Method in class org.sitemesh.ant.SiteMeshTask

ExportTagToContentRule - Class in org.sitemesh.content.tagrules.html

Exports the contents of a match tag to property of the passed in ContentProperty.

ExportTagToContentRule(SiteMeshContext, ContentProperty, boolean) - Constructor for class org.sitemesh.content.tagrules.html.ExportTagToContentRule

F

FileSystemDirectory - Class in org.sitemesh.offline.directory

Disk backed Directory implementation that uses java.io.File.

FileSystemDirectory(File) - Constructor for class org.sitemesh.offline.directory.FileSystemDirectory

FileSystemDirectory(File, Charset) - Constructor for class org.sitemesh.offline.directory.FileSystemDirectory

filterAlreadyAppliedForRequest(HttpServletRequest) - Method in class org.sitemesh.webapp.contentfilter.BasicSelector

flush() - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

flush() - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

flushBuffer() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

format(String, Object...) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

format(Locale, String, Object...) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

FramesetRule - Class in org.sitemesh.content.tagrules.html

Identifies whether a page contains frames (as these would typically have different rules for decoration - i.e.

FramesetRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.FramesetRule

G

get(String) - Method in class org.sitemesh.config.PathMapper

Retrieve appropriate key by matching patterns with supplied path.

getAttributeCount() - Method in class org.sitemesh.tagprocessor.CustomTag

getAttributeCount() - Method in interface org.sitemesh.tagprocessor.Tag

Number of attributes in tag.

getAttributeCount() - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getAttributeIndex(String, boolean) - Method in class org.sitemesh.tagprocessor.CustomTag

getAttributeIndex(String, boolean) - Method in interface org.sitemesh.tagprocessor.Tag

Determine which attribute has the specified name.

getAttributeIndex(String, boolean) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getAttributeName(int) - Method in class org.sitemesh.tagprocessor.CustomTag

getAttributeName(int) - Method in interface org.sitemesh.tagprocessor.Tag

Get name of attribute.

getAttributeName(int) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getAttributeValue(int) - Method in class org.sitemesh.tagprocessor.CustomTag

getAttributeValue(String, boolean) - Method in class org.sitemesh.tagprocessor.CustomTag

getAttributeValue(int) - Method in interface org.sitemesh.tagprocessor.Tag

Get value of an attribute.

getAttributeValue(String, boolean) - Method in interface org.sitemesh.tagprocessor.Tag

Get value of an attribute.

getAttributeValue(int) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getAttributeValue(String, boolean) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getAutoReload() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Whether the config file should be monitored for changes and automatically reloaded.

getBuffer() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Returns the underlying buffered content.

getChild(String) - Method in interface org.sitemesh.content.TreeNode

Get child by name, in relation to this node.

getChildren() - Method in interface org.sitemesh.content.TreeNode

Get immediate children of this node.

getConfigFileName() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Gets the SiteMesh XML config file name.

getConfigProperties(FilterConfig) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Return the configuration properties that are passed to PropertiesFilterConfigurator.

getContainerTweaks() - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

getContentProcessor() - Method in class org.sitemesh.BaseSiteMeshContext

getContentProcessor() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Get configured ContentProcessor.

getContentProcessor() - Method in interface org.sitemesh.SiteMeshContext

ContentProcessor used by this context.

getContentToMerge() - Method in class org.sitemesh.BaseSiteMeshContext

getContentToMerge() - Method in interface org.sitemesh.SiteMeshContext

The ContentProperty of the document being merged in to the decorator.

getContentType() - Method in class org.sitemesh.webapp.WebAppContext

getData() - Method in interface org.sitemesh.content.Content

The main data of the content - that is, the complete document.

getData() - Method in class org.sitemesh.content.memory.InMemoryContent

getDateHeader(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

getDecorator() - Method in class org.sitemesh.ant.SiteMeshFileSet

getDecoratorSelector() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Get configured DecoratorSelector.

getDefaultBufferContents() - Method in class org.sitemesh.tagprocessor.TagProcessor

Return the contents of the default buffer used during TagProcessing.

getDescendants() - Method in interface org.sitemesh.content.TreeNode

Get all descendants of this node.

getDestdir() - Method in class org.sitemesh.ant.SiteMeshFileSet

getDestinationDirectory() - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Get the destination directory.

getDestinationDirectory() - Method in class org.sitemesh.offline.SiteMeshOffline

Directory the generator writes the destination (decorated) files from.

getEncoding() - Method in class org.sitemesh.webapp.contentfilter.io.HttpContentType

getExtractedProperties() - Method in interface org.sitemesh.content.Content

Get a tree of extracted properties, that were captured by the ContentProcessor.

getExtractedProperties() - Method in class org.sitemesh.content.memory.InMemoryContent

getFileByPath(String) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

new ReadableByteChannel() { public int read(ByteBuffer dst) throws IOException { ByteBuffer buffer = dst.put(sourceData); return buffer.position(); } public boolean isOpen() { return true; } public void close() throws IOException { } }

getFilterConfig() - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

getFullPath(ContentProperty) - Static method in class org.sitemesh.content.debug.DumpingContentProcessor

getFullPath() - Method in interface org.sitemesh.content.TreeNode

Get the full path of this node, from the root node.

getHeader(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

This customized version of HttpServletRequest#getHeader(String) returns null for any HTTP header that is being filtered out.

getImplicitAndExplicitFileSet() - Method in class org.sitemesh.ant.SiteMeshTask

Returns the all implicit and explicit FileSets.

getLastModified() - Method in class org.sitemesh.webapp.contentfilter.ResponseMetaData

getName() - Method in interface org.sitemesh.content.TreeNode

Get the name of this node, in relation to the parent.

getName() - Method in class org.sitemesh.tagprocessor.CustomTag

getName() - Method in interface org.sitemesh.tagprocessor.Tag

Name of tag (ie.

getName() - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getNonNullValue() - Method in interface org.sitemesh.content.ContentChunk

Returns the value of this property as a String.

getObjectFactory() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

getObjectFactory() - Method in class org.sitemesh.config.properties.PropertiesConfigurator

getObjectFactory() - Method in class org.sitemesh.config.xml.XmlConfigurator

getOfficePropertyNames() - Method in class org.sitemesh.content.tagrules.msoffice.MsOfficeTagRuleBundle

getOutputStream() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

If buffering has been enabled for this request, it will return a stream that writes to the buffer, otherwise it will return the original stream.

getOutputStream() - Method in class org.sitemesh.webapp.contentfilter.io.Buffer

getOwningContent() - Method in interface org.sitemesh.content.ContentChunk

Returns the Content that this chunk belongs to.

getParent() - Method in interface org.sitemesh.content.TreeNode

Returns the parent node.

getPath() - Method in class org.sitemesh.offline.OfflineContext

getPath() - Method in interface org.sitemesh.SiteMeshContext

Get path of the page currently being displayed.

getPath() - Method in class org.sitemesh.webapp.WebAppContext

getPathMapper() - Method in class org.sitemesh.config.PathBasedDecoratorSelector

Returns path mapper in use.

getPatternInUse(String) - Method in class org.sitemesh.config.PathMapper

Retrieve appropriate pattern by matching patterns with supplied path.

getProperties() - Method in class org.sitemesh.config.cmdline.ArgParser

getProperty(Content, String) - Method in class org.sitemesh.content.tagrules.decorate.SiteMeshWriteRule

getRemaining() - Method in class org.sitemesh.config.cmdline.ArgParser

getRequest() - Method in class org.sitemesh.webapp.WebAppContext

getRequestPath(HttpServletRequest) - Static method in class org.sitemesh.webapp.WebAppContext

getResponse() - Method in class org.sitemesh.webapp.WebAppContext

getRule(String) - Method in class org.sitemesh.tagprocessor.State

getSelector() - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Get configured Selector.

getSelector() - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

getServletContext() - Method in class org.sitemesh.webapp.WebAppContext

getSourceDirectory() - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Get the source directory.

getSourceDirectory() - Method in class org.sitemesh.offline.SiteMeshOffline

Directory the generator reads the source (undecorated) files from.

getTagRuleBundles() - Method in class org.sitemesh.content.tagrules.TagBasedContentProcessor

getType() - Method in class org.sitemesh.tagprocessor.CustomTag

Type of tag.

getType() - Method in interface org.sitemesh.tagprocessor.Tag

Type of tag (e.g.

getType() - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

getType() - Method in class org.sitemesh.webapp.contentfilter.io.HttpContentType

getValue() - Method in interface org.sitemesh.content.ContentChunk

Returns the value of this property as a String.

getWriter() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

If buffering has been enabled for this request, it will return a writer that writes to the buffer, otherwise it will return the original writer.

getWriter() - Method in class org.sitemesh.webapp.contentfilter.io.Buffer

H

handleText(CharSequence, TagProcessorContext) - Method in class org.sitemesh.tagprocessor.State

hasAttribute(String, boolean) - Method in class org.sitemesh.tagprocessor.CustomTag

hasAttribute(String, boolean) - Method in interface org.sitemesh.tagprocessor.Tag

Determine if an attribute is present.

hasAttribute(String, boolean) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

hasChild(String) - Method in interface org.sitemesh.content.TreeNode

Returns whether the child node exists.

hasChildren() - Method in interface org.sitemesh.content.TreeNode

Returns whether this node has any child nodes.

hasDecorator() - Method in class org.sitemesh.ant.SiteMeshFileSet

hasDestdir() - Method in class org.sitemesh.ant.SiteMeshFileSet

hasDestdir(FileSet) - Method in class org.sitemesh.ant.SiteMeshTask

Checks to if the FileSet has a destdir set.

hashCode() - Method in class org.sitemesh.offline.directory.FileSystemDirectory

hashCode() - Method in class org.sitemesh.tagprocessor.CustomTag

hasValue() - Method in interface org.sitemesh.content.ContentChunk

Returns whether this property has a value set.

HtmlAttributesRule - Class in org.sitemesh.content.tagrules.html

Exports any attributes on the <html> tag as page properties.

HtmlAttributesRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.HtmlAttributesRule

HttpContentType - Class in org.sitemesh.webapp.contentfilter.io

Extracts the type and encoding from an HTTP Content-Type header.

HttpContentType(String) - Constructor for class org.sitemesh.webapp.contentfilter.io.HttpContentType

HttpServletRequestFilterable - Class in org.sitemesh.webapp.contentfilter

This special HttpServletRequestWrapper is used to allow filtering of the HTTP headers by adding them to an exclusion list.

HttpServletRequestFilterable(HttpServletRequest) - Constructor for class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

HttpServletResponseBuffer - Class in org.sitemesh.webapp.contentfilter

Wraps an HttpServletResponse, allowing the output to be buffered.

HttpServletResponseBuffer(HttpServletResponse, ResponseMetaData, Selector) - Constructor for class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

I

INCLUDE_ERROR_PAGES_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesFilterConfigurator

init(FilterConfig) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

init(FilterConfig) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

initContainerTweaks() - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

InMemoryContent - Class in org.sitemesh.content.memory

InMemoryContent() - Constructor for class org.sitemesh.content.memory.InMemoryContent

InMemoryDirectory - Class in org.sitemesh.offline.directory

Simple Directory implementation that stores contents in memory.

InMemoryDirectory() - Constructor for class org.sitemesh.offline.directory.InMemoryDirectory

InMemoryDirectory(Charset) - Constructor for class org.sitemesh.offline.directory.InMemoryDirectory

install(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.decorate.DecoratorTagRuleBundle

install(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.CoreHtmlTagRuleBundle

install(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.DivExtractingTagRuleBundle

install(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.html.Sm2TagRuleBundle

install(State, ContentProperty, SiteMeshContext) - Method in class org.sitemesh.content.tagrules.msoffice.MsOfficeTagRuleBundle

install(State, ContentProperty, SiteMeshContext) - Method in interface org.sitemesh.content.tagrules.TagRuleBundle

isBufferStreamBased() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Whether the underlying buffer was written to using HttpServletResponseBuffer.getOutputStream() (as opposed to HttpServletResponseBuffer.getWriter().

isComplexKey(String) - Static method in class org.sitemesh.config.PathMapper

Return true if the key contains wild cards.

isDefaultKey(String) - Static method in class org.sitemesh.config.PathMapper

Return true if the key default key matching all paths.

isExcluded(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

This method checks to see if the header name is within the exclusion list.

isIncludeErrorPages() - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

If error pages should be also decorated.

isMoreSpecific(String, String) - Static method in class org.sitemesh.config.PathMapper

Wheter the first pattern is more specific than the second one.

isSiteMeshFileSet(FileSet) - Method in class org.sitemesh.ant.SiteMeshTask

isSiteMeshFileSetWithoutDecorator(FileSet) - Method in class org.sitemesh.ant.SiteMeshTask

A helper method that checks if the given FileSet is an instance of SiteMesh and no decorator was set on the given FileSet.

isUsingStream() - Method in class org.sitemesh.webapp.contentfilter.io.Buffer

iterator() - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

L

length() - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

listAllFilePaths() - Method in interface org.sitemesh.offline.directory.Directory

Get a list of all file paths (relative to the Directory).

listAllFilePaths() - Method in class org.sitemesh.offline.directory.FileSystemDirectory

listAllFilePaths() - Method in class org.sitemesh.offline.directory.InMemoryDirectory

load(String) - Method in interface org.sitemesh.offline.directory.Directory

Load the contents from a file.

load(String, WritableByteChannel) - Method in interface org.sitemesh.offline.directory.Directory

Load binary data.

load(String) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

load(String, WritableByteChannel) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

load(String) - Method in class org.sitemesh.offline.directory.InMemoryDirectory

load(String, WritableByteChannel) - Method in class org.sitemesh.offline.directory.InMemoryDirectory

loadConfigXml(FilterConfig, String) - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Load the XML config file.

M

main(String[]) - Static method in class org.sitemesh.config.cmdline.CommandLineLauncher

MetaTagBasedDecoratorSelector<C extends SiteMeshContext> - Class in org.sitemesh.config

DecoratorSelector implementation that selects a decorator based on the meta tag in the page header

MetaTagBasedDecoratorSelector() - Constructor for class org.sitemesh.config.MetaTagBasedDecoratorSelector

MetaTagRule - Class in org.sitemesh.content.tagrules.html

Exports any <meta> tags as properties in the page.

MetaTagRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.MetaTagRule

MIME_TYPES_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesFilterConfigurator

MsOfficeTagRuleBundle - Class in org.sitemesh.content.tagrules.msoffice

TagRuleBundle that adds document properties from MS Office Word and Excel documents that have been saved as HTML.

MsOfficeTagRuleBundle() - Constructor for class org.sitemesh.content.tagrules.msoffice.MsOfficeTagRuleBundle

N

normalize(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletRequestFilterable

O

ObjectFactory - Interface in org.sitemesh.config

Responsible for instantiating objects - converting from strings in a config file to a real instance.

ObjectFactory.Default - Class in org.sitemesh.config

Default implementation of ObjectFactory that treats the object name as a class name, loading it from the current ClassLoader and instantiating with the default constructor.

ObjectFactory.Default() - Constructor for class org.sitemesh.config.ObjectFactory.Default

OfflineContext - Class in org.sitemesh.offline

SiteMesh SiteMeshContext implementation specifically for use in offline site generation.

OfflineContext(ContentProcessor, Directory, String) - Constructor for class org.sitemesh.offline.OfflineContext

org.sitemesh - package org.sitemesh

org.sitemesh.ant - package org.sitemesh.ant

org.sitemesh.builder - package org.sitemesh.builder

org.sitemesh.config - package org.sitemesh.config

org.sitemesh.config.cmdline - package org.sitemesh.config.cmdline

org.sitemesh.config.properties - package org.sitemesh.config.properties

org.sitemesh.config.xml - package org.sitemesh.config.xml

org.sitemesh.content - package org.sitemesh.content

org.sitemesh.content.debug - package org.sitemesh.content.debug

org.sitemesh.content.memory - package org.sitemesh.content.memory

org.sitemesh.content.tagrules - package org.sitemesh.content.tagrules

org.sitemesh.content.tagrules.decorate - package org.sitemesh.content.tagrules.decorate

org.sitemesh.content.tagrules.html - package org.sitemesh.content.tagrules.html

A set of commonly used out-of-the-box TagRules.

org.sitemesh.content.tagrules.msoffice - package org.sitemesh.content.tagrules.msoffice

org.sitemesh.offline - package org.sitemesh.offline

org.sitemesh.offline.directory - package org.sitemesh.offline.directory

org.sitemesh.tagprocessor - package org.sitemesh.tagprocessor

The SiteMesh TagProcessor

org.sitemesh.tagprocessor.util - package org.sitemesh.tagprocessor.util

org.sitemesh.webapp - package org.sitemesh.webapp

org.sitemesh.webapp.contentfilter - package org.sitemesh.webapp.contentfilter

Provides a mechanism for intercepting content generated by web-apps and making modifications to it.

org.sitemesh.webapp.contentfilter.io - package org.sitemesh.webapp.contentfilter.io

P

ParameterExtractingRule - Class in org.sitemesh.content.tagrules.html

Extracts the contents of any elements that look like <parameter name='x' value='y'> and write the contents to a page property (page.x=y).

ParameterExtractingRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.ParameterExtractingRule

parseSiteMeshXmlConfig(File) - Method in class org.sitemesh.ant.SiteMeshTask

PathBasedDecoratorSelector<C extends SiteMeshContext> - Class in org.sitemesh.config

DecoratorSelector implementation that selects a decorator based on the incoming SiteMeshContext.getPath() and the mappings setup.

PathBasedDecoratorSelector() - Constructor for class org.sitemesh.config.PathBasedDecoratorSelector

PathMapper<T> - Class in org.sitemesh.config

The PathMapper is used to map file patterns to keys, and find an approriate key for a given file path.

PathMapper() - Constructor for class org.sitemesh.config.PathMapper

popBuffer() - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

postProcess(String, CharBuffer, HttpServletRequest, HttpServletResponse, ResponseMetaData) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

postProcess(String, CharBuffer, HttpServletRequest, HttpServletResponse, ResponseMetaData) - Method in class org.sitemesh.webapp.SiteMeshFilter

preCommit() - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Hook that is called just before the response is committed.

print(Object) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(String) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(char[]) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(double) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(float) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(long) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(char) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(boolean) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

print(String) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(boolean) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(char) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(long) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(float) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

print(double) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

printf(String, Object...) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

printf(Locale, String, Object...) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(Object) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(String) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(char[]) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(double) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(float) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(long) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(char) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println(boolean) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println() - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

println() - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(String) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(boolean) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(char) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(long) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(float) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

println(double) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

process(Tag) - Method in class org.sitemesh.content.tagrules.html.FramesetRule

process(Tag) - Method in class org.sitemesh.content.tagrules.html.HtmlAttributesRule

process(Tag) - Method in class org.sitemesh.content.tagrules.html.MetaTagRule

process(Tag) - Method in class org.sitemesh.content.tagrules.html.ParameterExtractingRule

process(Tag) - Method in class org.sitemesh.content.tagrules.html.TagReplaceRule

process(String) - Method in class org.sitemesh.offline.SiteMeshOffline

Process a file (loaded from source directory), applying decorators and returning the result as a CharBuffer.

process(Tag) - Method in class org.sitemesh.tagprocessor.BasicBlockRule

process(Tag) - Method in class org.sitemesh.tagprocessor.BasicRule

process(Tag) - Method in class org.sitemesh.tagprocessor.StateTransitionRule

process() - Method in class org.sitemesh.tagprocessor.TagProcessor

Process the document, applying TagRules.

process(Tag) - Method in interface org.sitemesh.tagprocessor.TagRule

Implementations can use this to do any necessary work on the Tag such as extracting values or transforming it.

processContent(String, CharBuffer) - Method in class org.sitemesh.offline.SiteMeshOffline

Process content passed in, applying decorators and returning the result as a CharBuffer.

processEnd(Tag, SiteMeshDecorateRule.Holder) - Method in class org.sitemesh.content.tagrules.decorate.SiteMeshDecorateRule

processEnd(Tag, Object) - Method in class org.sitemesh.content.tagrules.decorate.SiteMeshWriteRule

processEnd(Tag, String) - Method in class org.sitemesh.content.tagrules.html.ContentBlockExtractingRule

processEnd(Tag, String) - Method in class org.sitemesh.content.tagrules.html.DivExtractingRule

processEnd(Tag, Object) - Method in class org.sitemesh.content.tagrules.html.ExportTagToContentRule

processEnd(Tag, Object) - Method in class org.sitemesh.content.tagrules.html.TitleExtractingRule

processEnd(Tag, T) - Method in class org.sitemesh.tagprocessor.BasicBlockRule

Called when a block is ended (i.e.

processFileSet(List<FileSet>) - Method in class org.sitemesh.ant.SiteMeshTask

Processes the FileSet to decorate all of the provided files.

processStart(Tag) - Method in class org.sitemesh.content.tagrules.decorate.SiteMeshDecorateRule

processStart(Tag) - Method in class org.sitemesh.content.tagrules.decorate.SiteMeshWriteRule

processStart(Tag) - Method in class org.sitemesh.content.tagrules.html.ContentBlockExtractingRule

processStart(Tag) - Method in class org.sitemesh.content.tagrules.html.DivExtractingRule

processStart(Tag) - Method in class org.sitemesh.content.tagrules.html.ExportTagToContentRule

processStart(Tag) - Method in class org.sitemesh.content.tagrules.html.TitleExtractingRule

processStart(Tag) - Method in class org.sitemesh.tagprocessor.BasicBlockRule

Called when a block is started (i.e.

PropertiesConfigurator - Class in org.sitemesh.config.properties

PropertiesConfigurator(ObjectFactory, Map<String, String>) - Constructor for class org.sitemesh.config.properties.PropertiesConfigurator

PropertiesFilterConfigurator - Class in org.sitemesh.config.properties

Configures a SiteMeshFilterBuilder from string key/value pairs.

PropertiesFilterConfigurator(ObjectFactory, Map<String, String>) - Constructor for class org.sitemesh.config.properties.PropertiesFilterConfigurator

PropertiesOfflineConfigurator - Class in org.sitemesh.config.properties

Configures a SiteMeshOfflineBuilder from string key/value pairs.

PropertiesOfflineConfigurator(ObjectFactory, Map<String, String>) - Constructor for class org.sitemesh.config.properties.PropertiesOfflineConfigurator

pushBuffer() - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Push a new destination output buffer onto the stack.

pushBuffer(CharSequenceBuffer) - Method in interface org.sitemesh.tagprocessor.TagProcessorContext

Push a new destination output buffer onto the stack.

put(String, String...) - Method in class org.sitemesh.config.MetaTagBasedDecoratorSelector

put(String, String...) - Method in class org.sitemesh.config.PathBasedDecoratorSelector

put(String, T) - Method in class org.sitemesh.config.PathMapper

Add a key and appropriate matching pattern.

R

reloadIfNecessary() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

reloadRequired() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

Determine if a reload is required.

removeAttribute(int) - Method in class org.sitemesh.tagprocessor.CustomTag

Remove an attribute.

removeAttribute(String, boolean) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the value of an attribute, or add an attribute if it does not already exist.

ResponseMetaData - Class in org.sitemesh.webapp.contentfilter

Holds additional information about the response.

ResponseMetaData() - Constructor for class org.sitemesh.webapp.contentfilter.ResponseMetaData

RoutablePrintWriter - Class in org.sitemesh.webapp.contentfilter.io

Provides a PrintWriter that routes through to another PrintWriter, however the destination can be changed at any point.

RoutablePrintWriter(RoutablePrintWriter.DestinationFactory) - Constructor for class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

RoutablePrintWriter.DestinationFactory - Interface in org.sitemesh.webapp.contentfilter.io

Factory to lazily instantiate the destination.

RoutableServletOutputStream - Class in org.sitemesh.webapp.contentfilter.io

Provides a ServletOutputStream that routes through to another ServletOutputStream, however the destination can be changed at any point.

RoutableServletOutputStream(RoutableServletOutputStream.DestinationFactory) - Constructor for class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

RoutableServletOutputStream.DestinationFactory - Interface in org.sitemesh.webapp.contentfilter.io

Factory to lazily instantiate the destination.

S

save(String, CharBuffer) - Method in interface org.sitemesh.offline.directory.Directory

Save the contents to a file, overwriting any existing content.

save(String, ReadableByteChannel, int) - Method in interface org.sitemesh.offline.directory.Directory

Save binary data.

save(String, CharBuffer) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

save(String, ReadableByteChannel, int) - Method in class org.sitemesh.offline.directory.FileSystemDirectory

save(String, CharBuffer) - Method in class org.sitemesh.offline.directory.InMemoryDirectory

save(String, ReadableByteChannel, int) - Method in class org.sitemesh.offline.directory.InMemoryDirectory

selectDecoratorPaths(Content, C) - Method in class org.sitemesh.config.MetaTagBasedDecoratorSelector

selectDecoratorPaths(Content, C) - Method in class org.sitemesh.config.PathBasedDecoratorSelector

selectDecoratorPaths(Content, C) - Method in interface org.sitemesh.DecoratorSelector

Implementations should never return null.

Selector - Interface in org.sitemesh.webapp.contentfilter

Rules that will be used by the ContentBufferingFilter and HttpServletResponseBuffer to determine whether the response should be buffered.

self() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

sendError(int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

sendError(int, String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

sendRedirect(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setAttributeName(int, String) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the name of an existing attribute.

setAttributeValue(String, boolean, String) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the value of an attribute, or add an attribute if it does not already exist.

setAttributeValue(int, String) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the value of an existing attribute.

setConfig(File) - Method in class org.sitemesh.ant.SiteMeshTask

Optional path to SiteMesh XML config file.

setContentLength(int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setContentType(String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

Enable/disable buffering for this request based on the result of Selector.shouldBufferForContentType(String, String, String).

setCustomContentProcessor(ContentProcessor) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Set the ContentProcessor.

setCustomDecoratorSelector(DecoratorSelector<CONTEXT>) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Set a custom DecoratorSelector.

setCustomSelector(Selector) - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Set a custom Selector.

setDateHeader(String, long) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setDecorator(String) - Method in class org.sitemesh.ant.SiteMeshFileSet

setDestdir(File) - Method in class org.sitemesh.ant.SiteMeshFileSet

setDestdir(File) - Method in class org.sitemesh.ant.SiteMeshTask

Destination directory where decorated content will be output to.

setDestinationDirectory(Directory) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set destination directory, were the processed files will be written to.

setDestinationDirectory(File) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set destination directory, were the processed files will be written to.

setDestinationDirectory(String) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set destination directory, were the processed files will be written to.

setHeader(String, String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setIncludeErrorPages(boolean) - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Set if the error pages should be decorated as well.

setIntHeader(String, int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setMimeTypes(String...) - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Set MIME types that the Filter should intercept.

setMimeTypes(List<String>) - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

Set MIME types that the Filter should intercept.

setName(String) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the name of the attribute.

setSourceDirectory(Directory) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set source directory, were the unprocessed files will be read from.

setSourceDirectory(File) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set source directory, were the processed files will be read from.

setSourceDirectory(String) - Method in class org.sitemesh.builder.BaseSiteMeshOfflineBuilder

Set source directory, were the processed files will be read from.

setSrcdir(File) - Method in class org.sitemesh.ant.SiteMeshTask

Source directory containing undecorated content and decorators.

setStatus(int) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setStatus(int, String) - Method in class org.sitemesh.webapp.contentfilter.HttpServletResponseBuffer

setTagProcessorContext(TagProcessorContext) - Method in class org.sitemesh.tagprocessor.BasicRule

setTagProcessorContext(TagProcessorContext) - Method in interface org.sitemesh.tagprocessor.TagRule

Injected by the TagProcessor before any of the other TagRule methods.

setTagRuleBundles(TagRuleBundle...) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Set the TagRuleBundles.

setTagRuleBundles(Iterable<TagRuleBundle>) - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Set the TagRuleBundles.

setType(Tag.Type) - Method in class org.sitemesh.tagprocessor.CustomTag

Change the type of the tag.

setup() - Method in class org.sitemesh.config.ConfigurableSiteMeshFilter

setupDefaults() - Method in class org.sitemesh.builder.BaseSiteMeshBuilder

Setup default settings.

setupDefaults() - Method in class org.sitemesh.builder.BaseSiteMeshFilterBuilder

See BaseSiteMeshFilterBuilder.setupDefaults().

setValue(CharSequence) - Method in interface org.sitemesh.content.ContentChunk

Sets the value.

shouldAbortBufferingForHttpStatusCode(int) - Method in class org.sitemesh.webapp.contentfilter.BasicSelector

shouldAbortBufferingForHttpStatusCode(int) - Method in interface org.sitemesh.webapp.contentfilter.Selector

Determine whether buffering should be used for a particular HTTP status code.

shouldAutoCreateSession() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks

shouldAutoCreateSession() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks.TomcatTweaks

shouldBufferForContentType(String, String, String) - Method in class org.sitemesh.webapp.contentfilter.BasicSelector

shouldBufferForContentType(String, String, String) - Method in interface org.sitemesh.webapp.contentfilter.Selector

Determine whether buffering should be used for a particular content-type.

shouldBufferForRequest(HttpServletRequest) - Method in class org.sitemesh.webapp.contentfilter.BasicSelector

shouldBufferForRequest(HttpServletRequest) - Method in interface org.sitemesh.webapp.contentfilter.Selector

Determine whether buffering should be used for a particular request.

shouldIgnoreIllegalStateExceptionOnErrorPage() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks

shouldIgnoreIllegalStateExceptionOnErrorPage() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks.WebLogicTweaks

shouldLogUnhandledExceptions() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks

shouldLogUnhandledExceptions() - Method in class org.sitemesh.webapp.contentfilter.ContainerTweaks.TomcatTweaks

shouldProcessTag(String) - Method in class org.sitemesh.tagprocessor.State

shouldProcessTag(String) - Method in interface org.sitemesh.tagprocessor.TagTokenizer.TokenHandler

Before attempting to parse a tag, the tokenizer will ask the handler whether the tag should be processed - avoiding additional tag parsing makes the tokenizer quicker.

SiteMeshContext - Interface in org.sitemesh

SiteMeshDecorateRule - Class in org.sitemesh.content.tagrules.decorate

Rule that applies decorators to inline blocks of content.

SiteMeshDecorateRule(SiteMeshContext) - Constructor for class org.sitemesh.content.tagrules.decorate.SiteMeshDecorateRule

SiteMeshFileSet - Class in org.sitemesh.ant

A SiteMesh FileSet that is aware of what decorator to apply for the given set of resource files.

SiteMeshFileSet() - Constructor for class org.sitemesh.ant.SiteMeshFileSet

SiteMeshFileSet(FileSet) - Constructor for class org.sitemesh.ant.SiteMeshFileSet

SiteMeshFilter - Class in org.sitemesh.webapp

The main SiteMesh Filter.

SiteMeshFilter(Selector, ContentProcessor, DecoratorSelector<WebAppContext>, boolean) - Constructor for class org.sitemesh.webapp.SiteMeshFilter

SiteMeshFilterBuilder - Class in org.sitemesh.builder

Convenient API for building the main SiteMesh Filter.

SiteMeshFilterBuilder() - Constructor for class org.sitemesh.builder.SiteMeshFilterBuilder

SiteMeshOffline - Class in org.sitemesh.offline

Tools for applying decorators to offline web pages (static content).

SiteMeshOffline(ContentProcessor, DecoratorSelector<OfflineContext>, Directory, Directory) - Constructor for class org.sitemesh.offline.SiteMeshOffline

SiteMeshOfflineBuilder - Class in org.sitemesh.builder

Convenient API for building the a SiteMeshOffline.

SiteMeshOfflineBuilder() - Constructor for class org.sitemesh.builder.SiteMeshOfflineBuilder

SiteMeshTask - Class in org.sitemesh.ant

SiteMeshTask() - Constructor for class org.sitemesh.ant.SiteMeshTask

SiteMeshWriteRule - Class in org.sitemesh.content.tagrules.decorate

Replaces tags that look like <sitemesh:write property='foo'/> with the ContentProperty being merged into the current document.

SiteMeshWriteRule(SiteMeshContext) - Constructor for class org.sitemesh.content.tagrules.decorate.SiteMeshWriteRule

size() - Method in class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

Sm2TagRuleBundle - Class in org.sitemesh.content.tagrules.html

TagRuleBundle that adds additional properties as used by SiteMesh 2 and earlier.

Sm2TagRuleBundle() - Constructor for class org.sitemesh.content.tagrules.html.Sm2TagRuleBundle

SOURCE_DIR_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesOfflineConfigurator

start() - Method in class org.sitemesh.tagprocessor.TagTokenizer

State - Class in org.sitemesh.tagprocessor

Acts a registry of TagRules to apply whilst the TagProcessor is processing the document in this particular state.

State() - Constructor for class org.sitemesh.tagprocessor.State

StateTransitionRule - Class in org.sitemesh.tagprocessor

StateTransitionRule(State) - Constructor for class org.sitemesh.tagprocessor.StateTransitionRule

StateTransitionRule(State, boolean) - Constructor for class org.sitemesh.tagprocessor.StateTransitionRule

subSequence(int, int) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

T

Tag - Interface in org.sitemesh.tagprocessor

Tag returned by TagTokenizer.

tag(Tag) - Method in interface org.sitemesh.tagprocessor.TagTokenizer.TokenHandler

Called when tokenizer encounters an HTML tag (open, close or empty).

Tag.Type - Enum in org.sitemesh.tagprocessor

Type of tag.

TAG_RULE_BUNDLES_PARAM - Static variable in class org.sitemesh.config.properties.PropertiesConfigurator

TagBasedContentProcessor - Class in org.sitemesh.content.tagrules

ContentProcessor implementation that is build on TagProcessor.

TagBasedContentProcessor(TagRuleBundle...) - Constructor for class org.sitemesh.content.tagrules.TagBasedContentProcessor

TagProcessor - Class in org.sitemesh.tagprocessor

Copies a document from a source to a destination, applying rules on the way to extract content and/or transform the content.

TagProcessor(CharBuffer) - Constructor for class org.sitemesh.tagprocessor.TagProcessor

tagProcessorContext - Variable in class org.sitemesh.tagprocessor.BasicRule

TagProcessorContext - Interface in org.sitemesh.tagprocessor

Defines a set of methods that allows TagRules to interact with the TagProcessor.

TagReplaceRule - Class in org.sitemesh.content.tagrules.html

Very simple rule for replacing all occurences of one tag with another.

TagReplaceRule(String) - Constructor for class org.sitemesh.content.tagrules.html.TagReplaceRule

TagRule - Interface in org.sitemesh.tagprocessor

User defined rule for processing Tags encountered by the TagProcessor.

TagRuleBundle - Interface in org.sitemesh.content.tagrules

A bundle of TagRules.

TagTokenizer - Class in org.sitemesh.tagprocessor

Splits a chunk of HTML into 'text' and 'tag' tokens, for easy processing.

TagTokenizer(CharBuffer, TagTokenizer.TokenHandler) - Constructor for class org.sitemesh.tagprocessor.TagTokenizer

TagTokenizer.ReusableToken - Class in org.sitemesh.tagprocessor

TagTokenizer.ReusableToken() - Constructor for class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

TagTokenizer.Token - Enum in org.sitemesh.tagprocessor

TagTokenizer.TokenHandler - Interface in org.sitemesh.tagprocessor

Handler that will receive callbacks as 'tags' and 'text' are encountered.

text(CharSequence) - Method in interface org.sitemesh.tagprocessor.TagTokenizer.TokenHandler

Called when tokenizer encounters anything other than a well-formed HTML tag.

TextEncoder - Class in org.sitemesh.webapp.contentfilter.io

Converts text as bytes to chars using specified encoding.

TextEncoder() - Constructor for class org.sitemesh.webapp.contentfilter.io.TextEncoder

TitleExtractingRule - Class in org.sitemesh.content.tagrules.html

Extracts the contents of the <title> element from the page and exports it as the title property.

TitleExtractingRule(ContentProperty) - Constructor for class org.sitemesh.content.tagrules.html.TitleExtractingRule

toByteBuffer() - Method in class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

toCharBuffer() - Method in class org.sitemesh.webapp.contentfilter.io.Buffer

toString() - Method in class org.sitemesh.offline.directory.FileSystemDirectory

toString() - Method in class org.sitemesh.tagprocessor.CustomTag

toString() - Method in interface org.sitemesh.tagprocessor.Tag

Get the complete tag in its original form, preserving original formatting.

toString() - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

toString() - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

toString() - Method in class org.sitemesh.webapp.contentfilter.io.Buffer

toString() - Method in class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

TreeNode<T extends TreeNode> - Interface in org.sitemesh.content

Represents a node of a tree-like data structure.

U

updateDestination(RoutablePrintWriter.DestinationFactory) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

updateDestination(RoutableServletOutputStream.DestinationFactory) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

updateLastModified(long) - Method in class org.sitemesh.webapp.contentfilter.ResponseMetaData

V

valueOf(String) - Static method in enum org.sitemesh.tagprocessor.Tag.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.sitemesh.tagprocessor.TagTokenizer.Token

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.sitemesh.tagprocessor.Tag.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.sitemesh.tagprocessor.TagTokenizer.Token

Returns an array containing the constants of this enum type, in the order they are declared.

verify() - Method in class org.sitemesh.ant.SiteMeshTask

Verify the required parameters.

W

warning(String, int, int) - Method in interface org.sitemesh.tagprocessor.TagTokenizer.TokenHandler

Called when tokenizer encounters something it cannot correctly parse.

WebAppContext - Class in org.sitemesh.webapp

SiteMesh SiteMeshContext implementation specifically for webapps running in a Servlet container.

WebAppContext(String, HttpServletRequest, HttpServletResponse, ServletContext, ContentProcessor, ResponseMetaData, boolean) - Constructor for class org.sitemesh.webapp.WebAppContext

wrapRequest(HttpServletRequest) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

Override to wrap the HttpServletRequest sent to the end point to be buffered.

write(int) - Method in class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

write(byte[], int, int) - Method in class org.sitemesh.webapp.contentfilter.io.ByteBufferBuilder

write(String) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

write(String, int, int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

write(char[]) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

write(char[], int, int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

write(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutablePrintWriter

write(int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

write(byte[]) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

write(byte[], int, int) - Method in class org.sitemesh.webapp.contentfilter.io.RoutableServletOutputStream

writeOriginal(HttpServletResponse, CharBuffer, HttpServletResponseBuffer) - Method in class org.sitemesh.webapp.contentfilter.ContentBufferingFilter

Write out the original unmodified buffer.

writeTo(Appendable) - Method in interface org.sitemesh.tagprocessor.CharSequenceBuffer

writeTo(Appendable) - Method in class org.sitemesh.tagprocessor.CustomTag

writeTo(Appendable) - Method in interface org.sitemesh.tagprocessor.Tag

Write out the complete tag in its original form, preserving original formatting.

writeTo(Appendable) - Method in class org.sitemesh.tagprocessor.TagTokenizer.ReusableToken

writeTo(Appendable) - Method in class org.sitemesh.tagprocessor.util.CharSequenceList

writeValueTo(Appendable) - Method in interface org.sitemesh.content.ContentChunk

Write the value of this property to out.

X

XmlConfigurator - Class in org.sitemesh.config.xml

XmlConfigurator(ObjectFactory, Element) - Constructor for class org.sitemesh.config.xml.XmlConfigurator

XmlFilterConfigurator - Class in org.sitemesh.config.xml

XmlFilterConfigurator(ObjectFactory, Element) - Constructor for class org.sitemesh.config.xml.XmlFilterConfigurator

XmlOfflineConfigurator - Class in org.sitemesh.config.xml

XmlOfflineConfigurator(ObjectFactory, Element) - Constructor for class org.sitemesh.config.xml.XmlOfflineConfigurator

A B C D E F G H I L M N O P R S T U V W X