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

A

AExpression() - Method in class org.webmacro.parser.WMParser_impl

ALL - Static variable in class org.webmacro.util.LogSystem

ASCII_CharStream - class org.webmacro.parser.ASCII_CharStream.

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

ASCII_CharStream(Reader, int, int, int) - Constructor for class org.webmacro.parser.ASCII_CharStream

ASCII_CharStream(Reader, int, int) - Constructor for class org.webmacro.parser.ASCII_CharStream

ASCII_CharStream(InputStream, int, int, int) - Constructor for class org.webmacro.parser.ASCII_CharStream

ASCII_CharStream(InputStream, int, int) - Constructor for class org.webmacro.parser.ASCII_CharStream

AVG_TIMEOUT - Static variable in class org.webmacro.resource.UrlProvider

AbstractLogFile - class org.webmacro.util.AbstractLogFile.

Abstract base class which implements most of the LogTarget interface, to make it easier to write new log targets that plug into WM.

AbstractLogFile(Settings) - Constructor for class org.webmacro.util.AbstractLogFile

Create a new LogFile instance reading properties from the supplied Settings object.

AbstractLogFile() - Constructor for class org.webmacro.util.AbstractLogFile

AbstractTemplateLoader - class org.webmacro.resource.AbstractTemplateLoader.

Abstract implementation of TemplateLoader, that stores broker and path and provides a ReloadDelayDecorator and a common log object.

AbstractTemplateLoader() - Constructor for class org.webmacro.resource.AbstractTemplateLoader

AlternateDirective - class org.webmacro.directive.AlternateDirective.

Use the #alternate directive to create an "alternating" variable, which is useful for creating tables that use a different background color for each line, etc.

AlternateDirective() - Constructor for class org.webmacro.directive.AlternateDirective

AndExpression() - Method in class org.webmacro.parser.WMParser_impl

ArgList() - Method in class org.webmacro.parser.WMParser_impl

ArgType_ARGLIST - Static variable in class org.webmacro.directive.Directive

ArgType_ASSIGN - Static variable in class org.webmacro.directive.Directive

ArgType_BLOCK - Static variable in class org.webmacro.directive.Directive

ArgType_CHOICE - Static variable in class org.webmacro.directive.Directive

ArgType_CONDITION - Static variable in class org.webmacro.directive.Directive

ArgType_GROUP - Static variable in class org.webmacro.directive.Directive

ArgType_KEYWORD - Static variable in class org.webmacro.directive.Directive

ArgType_LITBLOCK - Static variable in class org.webmacro.directive.Directive

ArgType_LVALUE - Static variable in class org.webmacro.directive.Directive

ArgType_NAME - Static variable in class org.webmacro.directive.Directive

ArgType_QUOTEDSTRING - Static variable in class org.webmacro.directive.Directive

ArgType_RVALUE - Static variable in class org.webmacro.directive.Directive

ArgType_STRING - Static variable in class org.webmacro.directive.Directive

ArgType_SUBDIRECTIVE - Static variable in class org.webmacro.directive.Directive

ArgsHolder - class org.webmacro.directive.ArgsHolder.

ArgsHolder is a container for directive arguments.

ArgsHolder(Directive.ArgDescriptor[]) - Constructor for class org.webmacro.directive.ArgsHolder

Argument - class org.webmacro.engine.Argument.

A predicate is a term passed to a Directive.

Argument(String, Object) - Constructor for class org.webmacro.engine.Argument

Create a new predicate

ArrayIterator - class org.webmacro.util.ArrayIterator.

This provides an iterator interface to an array

ArrayIterator(Object[]) - Constructor for class org.webmacro.util.ArrayIterator

Construct an iterator given an enumeration

AttributeDirective - class org.webmacro.directive.AttributeDirective.

The #attribute directive allows you to set a template attribute such that it is accessible from the servlet.

AttributeDirective() - Constructor for class org.webmacro.directive.AttributeDirective

abs(int) - Static method in class org.webmacro.servlet.MathTool

abs(long) - Static method in class org.webmacro.servlet.MathTool

abs(float) - Static method in class org.webmacro.servlet.MathTool

abs(double) - Static method in class org.webmacro.servlet.MathTool

accept(TemplateVisitor) - Method in interface org.webmacro.Visitable

accept(TemplateVisitor) - Method in class org.webmacro.directive.AlternateDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.BeanDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.CommentDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.DefaultDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.Directive

accept(TemplateVisitor) - Method in class org.webmacro.directive.DummyDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.EvalDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.ForeachDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.IncludeDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.MacroDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.SetDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.SetblockDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.SetpropsDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.TempletDirective

Used by template visitors

accept(TemplateVisitor) - Method in class org.webmacro.directive.TextDirective

accept(TemplateVisitor) - Method in class org.webmacro.directive.TypeDirective

accept(TemplateVisitor) - Method in class org.webmacro.engine.Block

accept(TemplateVisitor) - Method in class org.webmacro.engine.Expression.AndOperation

accept(TemplateVisitor) - Method in class org.webmacro.engine.Expression.BinaryOperation

accept(TemplateVisitor) - Method in class org.webmacro.engine.Expression.OrOperation

accept(TemplateVisitor) - Method in class org.webmacro.engine.Expression.UnaryOperation

accept(TemplateVisitor) - Method in class org.webmacro.engine.MacroAdapter

accept(TemplateVisitor) - Method in class org.webmacro.engine.StringMacroAdapter

accept(TemplateVisitor) - Method in class org.webmacro.engine.UndefinedMacro

accept(TemplateVisitor) - Method in class org.webmacro.engine.Variable

accept(TemplateVisitor) - Method in class org.webmacro.engine.WMTemplate

accept(WebContext) - Method in interface org.webmacro.servlet.Handler

This is the primary method you override to create a new handler.

addContextReference(String, Object) - Method in class org.webmacro.util.WMStringEval

Adds a reference to the context.

addElement(Object) - Method in class org.webmacro.engine.BlockBuilder

addElement(Object, int, int) - Method in class org.webmacro.engine.BlockBuilder

addEscapes(String) - Static method in class org.webmacro.parser.TokenMgrError

Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string

addFileset(FileSet) - Method in class org.webmacro.tools.WMTemplateAntTask

addObserver(LogSystem) - Method in class org.webmacro.util.AbstractLogFile

addObserver(LogSystem) - Method in class org.webmacro.util.CommonsLoggingTarget

addObserver(LogSystem) - Method in interface org.webmacro.util.LogTarget

A LogSystem will register itself though this method in order to detect changes to the LogTarget.

addProvider(Provider, String) - Method in class org.webmacro.Broker

Register a new provider, calling its getType() method to find out what type of requests it wants to serve.

addRequestAttributes(ServletRequest) - Method in class org.webmacro.util.SparseProperties

Adds all the Request attributes to this property object.

addTarget(LogTarget) - Method in class org.webmacro.util.LogSystem

Add a new LogTarget to the LogSystem.

add_escapes(String) - Method in class org.webmacro.parser.ParseException

Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

append(Object, Object) - Static method in class org.webmacro.servlet.ListUtil

append one list to the end of another and return the expanded list.

args - Variable in class org.webmacro.directive.Directive.Subdirective

args - Variable in class org.webmacro.directive.DirectiveDescriptor

arguments - Variable in class org.webmacro.PropertyException.NoSuchMethodWithArgumentsException

B

BEGIN - Static variable in interface org.webmacro.parser.WMParser_implConstants

BOOLEAN - Static variable in class org.webmacro.util.CastUtil

BREAKING - Static variable in class org.webmacro.directive.Directive.Subdirective

BROKERS - Static variable in class org.webmacro.Broker

BUILD_DATE - Static variable in interface org.webmacro.WebMacro

BYTE - Static variable in class org.webmacro.util.CastUtil

BackupCharStream - class org.webmacro.parser.BackupCharStream.

An implementation of interface CharStream.

BackupCharStream(Reader) - Constructor for class org.webmacro.parser.BackupCharStream

BackupCharStream(Reader, int, int, int) - Constructor for class org.webmacro.parser.BackupCharStream

BackupCharStream(Reader, int, int) - Constructor for class org.webmacro.parser.BackupCharStream

BackupCharStream(InputStream, int, int, int) - Constructor for class org.webmacro.parser.BackupCharStream

BackupCharStream(InputStream, int, int) - Constructor for class org.webmacro.parser.BackupCharStream

Bag - interface org.webmacro.util.Bag.

A dictionary like interface, but more restricted--provides a common interface for generic containers which are less functional than a dictionary, but similar in nature.

Base64 - class org.webmacro.util.Base64.

A set of utility methods for working with Base64.

Base64() - Constructor for class org.webmacro.util.Base64

BeanDirective - class org.webmacro.directive.BeanDirective.

Implements a directive allowing a script writer to instantiate an arbitrary java object in a WebMacro template subject to security restrictions.

BeanDirective() - Constructor for class org.webmacro.directive.BeanDirective

BeforeBlock() - Method in class org.webmacro.parser.WMParser_impl

BeginToken() - Method in class org.webmacro.parser.ASCII_CharStream

BeginToken() - Method in class org.webmacro.parser.BackupCharStream

BeginToken() - Method in interface org.webmacro.parser.CharStream

Returns the next character that marks the beginning of the next token.

Block - class org.webmacro.engine.Block.

A Block is essentially a Macro[] that knows how to write itself out as a String.

Block(String, String[], Macro[], int[], int[]) - Constructor for class org.webmacro.engine.Block

A Block must be constructed from a BlockBuilder.

Block(Directive.Subdirective[]) - Method in class org.webmacro.parser.WMParser_impl

BlockBuilder - class org.webmacro.engine.BlockBuilder.

A block represents the text between two {}'s in a template, or else the text that begins at the start of the template and runs until its end ({}'s around the whole document are not required).

BlockBuilder() - Constructor for class org.webmacro.engine.BlockBuilder

BlockBuilder(String) - Constructor for class org.webmacro.engine.BlockBuilder

BlockBuilder.BBIterator - class org.webmacro.engine.BlockBuilder.BBIterator.

BlockBuilder.BBIterator() - Constructor for class org.webmacro.engine.BlockBuilder.BBIterator

BlockBuilder.BlockIterator - interface org.webmacro.engine.BlockBuilder.BlockIterator.

BracketList() - Method in class org.webmacro.parser.WMParser_impl

Broker - class org.webmacro.Broker.

The Broker is responsible for loading and initializing almost everything in WebMacro.

Broker() - Constructor for class org.webmacro.Broker

Equivalent to Broker("WebMacro.properties"), except that it doesn't complain if WebMacro.properties can't be found.

Broker(Properties) - Constructor for class org.webmacro.Broker

Equivalent to Broker("WebMacro.properties"), except that it doesn't complain if WebMacro.properties can't be found, and it loads properties from a specified Properties.

Broker(String) - Constructor for class org.webmacro.Broker

Search the classpath for the properties file under the specified name.

Broker(Broker, String) - Constructor for class org.webmacro.Broker

Explicitly provide the properties that WebMacro should configure from.

BrokerTemplateLoader - class org.webmacro.resource.BrokerTemplateLoader.

BrokerTemplateLoader() - Constructor for class org.webmacro.resource.BrokerTemplateLoader

BrokerTemplateProvider - class org.webmacro.resource.BrokerTemplateProvider.

The BrokerTemplateProvider loads templates through Broker.getResource().

BrokerTemplateProvider() - Constructor for class org.webmacro.resource.BrokerTemplateProvider

BrokerTemplateProviderHelper - class org.webmacro.resource.BrokerTemplateProviderHelper.

This class does the actual work of retrieving templates using the Broker.

BrokerTemplateProviderHelper() - Constructor for class org.webmacro.resource.BrokerTemplateProviderHelper

BuildContext - class org.webmacro.engine.BuildContext.

Contains data structures which are manipulated during the builder phase of parsing.

BuildContext(Broker) - Constructor for class org.webmacro.engine.BuildContext

BuildException - exception org.webmacro.engine.BuildException.

BuildException(String) - Constructor for class org.webmacro.engine.BuildException

BuildException(String, Throwable) - Constructor for class org.webmacro.engine.BuildException

Builder - interface org.webmacro.engine.Builder.

ByteBufferOutputStream - class org.webmacro.util.ByteBufferOutputStream.

An optimized implementation of a ByteBuffer stream.

ByteBufferOutputStream(int) - Constructor for class org.webmacro.util.ByteBufferOutputStream

Create a new ByteBuffer with the specified capacity

backup(int) - Method in class org.webmacro.parser.ASCII_CharStream

backup(int) - Method in class org.webmacro.parser.BackupCharStream

backup(int) - Method in interface org.webmacro.parser.CharStream

Backs up the input stream by amount steps.

beginBlock() - Method in class org.webmacro.TemplateVisitor

beginBlock() - Method in class org.webmacro.engine.TemplateDumper

beginColumn - Variable in class org.webmacro.parser.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

beginDirective(String) - Method in class org.webmacro.TemplateVisitor

beginDirective(String) - Method in class org.webmacro.engine.TemplateDumper

beginLine - Variable in class org.webmacro.parser.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

broker - Variable in class org.webmacro.resource.AbstractTemplateLoader

Our broker

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.AlternateDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.AttributeDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.BeanDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.CommentDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.CountDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.DefaultDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.Directive

Directives must implement a build() method.

build(BuildContext) - Method in class org.webmacro.directive.DirectiveBuilder

Build the directive.

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.DummyDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.EvalDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.ForeachDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.GlobalDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.IncludeDirective

Build this use of the directive.

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.MacroDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.ParamDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.SetDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.SetblockDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.SetpropsDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.TempletDirective

Build the directive.

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.TextDirective

build(DirectiveBuilder, BuildContext) - Method in class org.webmacro.directive.TypeDirective

configure directive for this run and return 'this'

build(BuildContext) - Method in class org.webmacro.engine.BlockBuilder

build(BuildContext) - Method in interface org.webmacro.engine.Builder

build(Object, Object) - Method in class org.webmacro.engine.Expression.AddBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.AndBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.BinaryOperationBuilder

build(BuildContext) - Method in class org.webmacro.engine.Expression.BinaryOperationBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareEqBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareGeBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareGtBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareLeBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareLtBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.CompareNeBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.DivideBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.MultiplyBuilder

build(Object) - Method in class org.webmacro.engine.Expression.NotBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.OrBuilder

build(Object, Object) - Method in class org.webmacro.engine.Expression.SubtractBuilder

build(Object) - Method in class org.webmacro.engine.Expression.UnaryOperationBuilder

build(BuildContext) - Method in class org.webmacro.engine.Expression.UnaryOperationBuilder

build(BuildContext) - Method in class org.webmacro.engine.FunctionCallBuilder

build(BuildContext) - Method in class org.webmacro.engine.ListBuilder

build(BuildContext) - Method in class org.webmacro.engine.MacroBuilder

Expand the macro.

build(BuildContext) - Method in class org.webmacro.engine.MapBuilder

build(BuildContext) - Method in class org.webmacro.engine.NullBuilder

build(BuildContext) - Method in class org.webmacro.engine.ParamBuilder

build(BuildContext) - Method in class org.webmacro.engine.PropertyMethodBuilder

build(BuildContext) - Method in class org.webmacro.engine.QuotedStringBuilder

build(BuildContext) - Method in class org.webmacro.engine.VariableBuilder

buildAsArray(BuildContext) - Method in class org.webmacro.engine.ListBuilder

buildLocale(String) - Static method in class org.webmacro.servlet.LocaleTool

access to the static members such as Locale.US, etc If that field doesn't exist try to construct a locale from a string so templates can have $Locale.en_GB.

buildView(String) - Method in class org.webmacro.adapter.spring.WebMacroViewResolver

bytesToString(byte[]) - Static method in class org.webmacro.servlet.TextTool

convert a byte[] to a String using the system-default encoding

bytesToString(byte[], String) - Static method in class org.webmacro.servlet.TextTool

convert a byte[] to a String using the specified encoding

C

CExpression() - Method in class org.webmacro.parser.WMParser_impl

CGITool - class org.webmacro.servlet.CGITool.

Provide Template variables that implement the CGI standard for script variable names.

CGITool() - Constructor for class org.webmacro.servlet.CGITool

CGI_Impersonator - class org.webmacro.servlet.CGI_Impersonator.

Provided to mimic the CGI environment within the WebMacro script language via introspection.

CHAR - Static variable in class org.webmacro.util.CastUtil

COLON - Static variable in interface org.webmacro.parser.WMParser_implConstants

COMMA - Static variable in interface org.webmacro.parser.WMParser_implConstants

COMMENT - Static variable in interface org.webmacro.parser.WMParser_implConstants

COMMENT_ELSE - Static variable in interface org.webmacro.parser.WMParser_implConstants

CacheElement - class org.webmacro.resource.CacheElement.

CacheElement is an abstract class which cache managers can subclass.

CacheElement() - Constructor for class org.webmacro.resource.CacheElement

CacheManager - interface org.webmacro.resource.CacheManager.

The CacheManager sits between the template provider and WM.

CacheReloadContext - class org.webmacro.resource.CacheReloadContext.

CacheReloadContext provides support for providers which support cache invalidation on a per-element basis, for example if an underlying resource has changed.

CacheReloadContext() - Constructor for class org.webmacro.resource.CacheReloadContext

CachingProvider - class org.webmacro.resource.CachingProvider.

CacheManager is an abstract base class for providers which wish to implement caching functionality.

CachingProvider() - Constructor for class org.webmacro.resource.CachingProvider

CastUtil - class org.webmacro.util.CastUtil.

A singleton for casting one type to another.

CharStream - interface org.webmacro.parser.CharStream.

This interface describes a character stream that maintains line and column number positions of the characters.

CheckTemplates - class org.webmacro.tools.CheckTemplates.

CheckTemplates Program which uses the WebMacro parser to validate templates

CheckTemplates() - Constructor for class org.webmacro.tools.CheckTemplates

ClassPathTemplateLoader - class org.webmacro.resource.ClassPathTemplateLoader.

Implementation of TemplateLoader that loads template from the classpath.

ClassPathTemplateLoader() - Constructor for class org.webmacro.resource.ClassPathTemplateLoader

Clock - class org.webmacro.util.Clock.

This is an optimization.

Clock() - Constructor for class org.webmacro.util.Clock

Comment(ParserBlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

CommentDirective - class org.webmacro.directive.CommentDirective.

Allows a template writer to make a block comment.

CommentDirective() - Constructor for class org.webmacro.directive.CommentDirective

CommonsLoggingTarget - class org.webmacro.util.CommonsLoggingTarget.

Not sure what the log level mappings should be here but going with: WM Debug -> Commons Debug WM Warning -> Commons Warn WM Info -> Commons Trace WM Notice -> Commons Info WM Error -> Commons Error

CommonsLoggingTarget() - Constructor for class org.webmacro.util.CommonsLoggingTarget

Conditional() - Method in class org.webmacro.parser.WMParser_impl

ConfigException - exception org.webmacro.servlet.ConfigException.

This is an exception, which Config may throw if something is wrong with the config file eg default variables cannot be located

ConfigException(String) - Constructor for class org.webmacro.servlet.ConfigException

Constructor only requires a reason

ConfigProvider - class org.webmacro.resource.ConfigProvider.

A very simple provider which simply takes the config information passed to it by the broker and returns it.

ConfigProvider() - Constructor for class org.webmacro.resource.ConfigProvider

ConstantPropertyVariable - class org.webmacro.engine.ConstantPropertyVariable.

Operate on bean properties of a compile-time constant

Context - class org.webmacro.Context.

A Context contains state.

Context() - Constructor for class org.webmacro.Context

Create a new Context relative to the default WM instance

Context(Broker) - Constructor for class org.webmacro.Context

Create a new Context relative to the supplied broker

Context.TemplateEvaluationContext - class org.webmacro.Context.TemplateEvaluationContext.

Context.TemplateEvaluationContext() - Constructor for class org.webmacro.Context.TemplateEvaluationContext

ContextAutoLoader - interface org.webmacro.broker.ContextAutoLoader.

ContextAutoLoader

ContextException - exception org.webmacro.ContextException.

The context supplied to a macro did not contain information that the macro required in order to write or evaluate itself, or there was some problem with the way the Context was used.

ContextException() - Constructor for class org.webmacro.ContextException

ContextException(String) - Constructor for class org.webmacro.ContextException

ContextException(String, Throwable) - Constructor for class org.webmacro.ContextException

ContextObjectFactory - interface org.webmacro.broker.ContextObjectFactory.

ContextObjectFactory This interface replaces ContextTool.

ContextTool - class org.webmacro.ContextTool.

This class is used as a base class for legacy context tools so they can fit into the ContextObjectFactory framework.

ContextTool() - Constructor for class org.webmacro.ContextTool

CookieJar - class org.webmacro.servlet.CookieJar.

Provide access to form variables

CookieTool - class org.webmacro.servlet.CookieTool.

Provide Template with access to form data.

CookieTool() - Constructor for class org.webmacro.servlet.CookieTool

CountDirective - class org.webmacro.directive.CountDirective.

#count $i from 1 to 100 [step 1]

CountDirective() - Constructor for class org.webmacro.directive.CountDirective

CrankyEvaluationExceptionHandler - class org.webmacro.engine.CrankyEvaluationExceptionHandler.

CrankyEvaluationExceptionHandler An implementation of EvaluationExceptionHandler which throws an exception whenever it is called.

CrankyEvaluationExceptionHandler() - Constructor for class org.webmacro.engine.CrankyEvaluationExceptionHandler

CrankyEvaluationExceptionHandler(Broker) - Constructor for class org.webmacro.engine.CrankyEvaluationExceptionHandler

CurlyMap() - Method in class org.webmacro.parser.WMParser_impl

children - Variable in class org.webmacro.directive.Directive.ArgDescriptor

classForName(String) - Method in class org.webmacro.Broker

Load a class through the broker's class loader.

classForName(String) - Method in class org.webmacro.servlet.Servlet20Broker

Loads a class by name.

classForName(String) - Method in class org.webmacro.servlet.Servlet22Broker

Loads a class by name.

classForName(String) - Method in class org.webmacro.util.Instantiator

className - Variable in class org.webmacro.PropertyException.NoSuchMethodException

className - Variable in class org.webmacro.PropertyException.NoSuchMethodWithArgumentsException

clear() - Method in class org.webmacro.Context

Clear the context so that it can be used for another request.

clear() - Method in class org.webmacro.servlet.WebContext

Clear a WebContext of it's non-shared data

clone() - Method in class org.webmacro.Context

See cloneContext().

cloneContext() - Method in class org.webmacro.Context

Create a copy of this context.

close() - Method in class org.webmacro.FastWriter

compare(String, String) - Method in class org.webmacro.engine.Expression.Compare

compare(long, long) - Method in class org.webmacro.engine.Expression.Compare

compare(Object, Object) - Method in class org.webmacro.engine.Expression.Compare

compare(Object, Object) - Method in class org.webmacro.engine.Expression.CompareEq

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareEq

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareEq

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareGe

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareGe

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareGt

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareGt

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareLe

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareLe

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareLt

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareLt

compare(Object, Object) - Method in class org.webmacro.engine.Expression.CompareNe

compare(String, String) - Method in class org.webmacro.engine.Expression.CompareNe

compare(long, long) - Method in class org.webmacro.engine.Expression.CompareNe

compareNull(Object) - Method in class org.webmacro.engine.Expression.Compare

compareNull(Object) - Method in class org.webmacro.engine.Expression.CompareEq

compareNull(Object) - Method in class org.webmacro.engine.Expression.CompareNe

contains(List, Object) - Static method in class org.webmacro.servlet.ListUtil

contains(Object[], Object) - Static method in class org.webmacro.servlet.ListUtil

contains(Object, Object) - Static method in class org.webmacro.servlet.ListUtil

containsKey(Object) - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

containsKey(Object) - Method in class org.webmacro.engine.MacroBuildContext

containsKey(String) - Method in class org.webmacro.util.Settings

Find out if a setting is defined

containsKey(String) - Method in class org.webmacro.util.SubSettings

Find out if a setting is defined

containsValue(Object) - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

copy(Object) - Static method in class org.webmacro.servlet.ListUtil

create a new list (ArrayList) with all the elements in the supplied list

copyCurrentContext() - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

Copies all variables from the current request context into the context of the macro.

create() - Static method in class org.webmacro.servlet.ListUtil

create a new ArrayList

create(int) - Static method in class org.webmacro.servlet.ListUtil

create a new ArrayList with the specified capacity

createClasspath() - Method in class org.webmacro.tools.WMTemplateAntTask

createFactory(String) - Method in class org.webmacro.resource.DelegatingTemplateProvider

createLogTarget(Broker, String, Settings) - Method in class org.webmacro.util.LogTargetFactory

Creates a new org.webmacro.util.LogTarget

createMacro(Object) - Static method in class org.webmacro.engine.MacroAdapter

If wrapMe is not a Macro, wrap it and return it.

createRange(int, int) - Static method in class org.webmacro.servlet.ListUtil

createRange(int, int, int) - Static method in class org.webmacro.servlet.ListUtil

createTypesFromArgs(Object[]) - Static method in class org.webmacro.engine.IntrospectionUtils

curChar - Variable in class org.webmacro.parser.WMParser_implTokenManager

currentToken - Variable in class org.webmacro.parser.ParseException

This is the last token that has been consumed successfully.

D

DEBUG - Static variable in class org.webmacro.Flags

Use debug statements in performance critical code?

DEBUG - Static variable in class org.webmacro.util.LogSystem

DEFAULT - Static variable in interface org.webmacro.parser.WMParser_implConstants

DIRECTIVE_KEY - Static variable in class org.webmacro.directive.DirectiveProvider

DOLLAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

DOT - Static variable in interface org.webmacro.parser.WMParser_implConstants

DOUBLE - Static variable in class org.webmacro.util.CastUtil

DebugEvaluationExceptionHandler - class org.webmacro.engine.DebugEvaluationExceptionHandler.

DebugEvaluationExceptionHandler() - Constructor for class org.webmacro.engine.DebugEvaluationExceptionHandler

DebugEvaluationExceptionHandler(Broker) - Constructor for class org.webmacro.engine.DebugEvaluationExceptionHandler

DefaultContextAutoLoader - class org.webmacro.broker.DefaultContextAutoLoader.

DefaultContextAutoLoader

DefaultContextAutoLoader() - Constructor for class org.webmacro.broker.DefaultContextAutoLoader

DefaultDirective - class org.webmacro.directive.DefaultDirective.

Implements the directive that allows a template to have a default value for a reference in the context.

DefaultDirective() - Constructor for class org.webmacro.directive.DefaultDirective

DefaultEvaluationExceptionHandler - class org.webmacro.engine.DefaultEvaluationExceptionHandler.

DefaultEvaluationExceptionHandler() - Constructor for class org.webmacro.engine.DefaultEvaluationExceptionHandler

DefaultEvaluationExceptionHandler(Broker) - Constructor for class org.webmacro.engine.DefaultEvaluationExceptionHandler

DefaultTemplateLoaderFactory - class org.webmacro.resource.DefaultTemplateLoaderFactory.

Default implementation of TemplateLoaderFactory interface.

DefaultTemplateLoaderFactory() - Constructor for class org.webmacro.resource.DefaultTemplateLoaderFactory

DelegatingTemplateProvider - class org.webmacro.resource.DelegatingTemplateProvider.

Alternative implementation of a TemplateProvider that uses TemplateLoaders to do the actual work.

DelegatingTemplateProvider() - Constructor for class org.webmacro.resource.DelegatingTemplateProvider

DictionaryTool - class org.webmacro.util.DictionaryTool.

A HashTool wraps a java.util.Dictionary and provides additional features

DictionaryTool(Dictionary) - Constructor for class org.webmacro.util.DictionaryTool

Wrap the supplied dictionary.

Directive - class org.webmacro.directive.Directive.

Directive is an abstract class which directives can extend.

Directive() - Constructor for class org.webmacro.directive.Directive

Directive(ParserBlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

Directive.ArgDescriptor - class org.webmacro.directive.Directive.ArgDescriptor.

ArgDescriptor is the base class for all the different types of argument descriptors, like ConditionalArg, KeywordArg, RValueArg, etc.

Directive.ArgDescriptor(int, int) - Constructor for class org.webmacro.directive.Directive.ArgDescriptor

Directive.AssignmentArg - class org.webmacro.directive.Directive.AssignmentArg.

Assignment.

Directive.AssignmentArg() - Constructor for class org.webmacro.directive.Directive.AssignmentArg

Directive.BlockArg - class org.webmacro.directive.Directive.BlockArg.

Block argument type.

Directive.BlockArg(int) - Constructor for class org.webmacro.directive.Directive.BlockArg

Directive.ConditionArg - class org.webmacro.directive.Directive.ConditionArg.

Condition argument type.

Directive.ConditionArg(int) - Constructor for class org.webmacro.directive.Directive.ConditionArg

Directive.ExactlyOneChoice - class org.webmacro.directive.Directive.ExactlyOneChoice.

The ExactlyOneChoice indicates that exactly one of several optional groups can be accepted, only once.

Directive.ExactlyOneChoice(int) - Constructor for class org.webmacro.directive.Directive.ExactlyOneChoice

Directive.FormalArgListArg - class org.webmacro.directive.Directive.FormalArgListArg.

Argument list.

Directive.FormalArgListArg(int) - Constructor for class org.webmacro.directive.Directive.FormalArgListArg

Directive.KeywordArg - class org.webmacro.directive.Directive.KeywordArg.

Keyword argument type.

Directive.KeywordArg(int, String) - Constructor for class org.webmacro.directive.Directive.KeywordArg

Directive.LValueArg - class org.webmacro.directive.Directive.LValueArg.

LValue argument type.

Directive.LValueArg(int) - Constructor for class org.webmacro.directive.Directive.LValueArg

Directive.LiteralBlockArg - class org.webmacro.directive.Directive.LiteralBlockArg.

Literal block argument type.

Directive.LiteralBlockArg(int) - Constructor for class org.webmacro.directive.Directive.LiteralBlockArg

Directive.NameArg - class org.webmacro.directive.Directive.NameArg.

Implements an argument as a simple name.

Directive.NameArg(int) - Constructor for class org.webmacro.directive.Directive.NameArg

Directive.NotSimpleVariableBuildException - exception org.webmacro.directive.Directive.NotSimpleVariableBuildException.

Utility exception used by directives to signal that an argument that was supposed to be a simple Variable (only one term) is not.

Directive.NotSimpleVariableBuildException(String) - Constructor for class org.webmacro.directive.Directive.NotSimpleVariableBuildException

Directive.NotSimpleVariableBuildException(String, Exception) - Constructor for class org.webmacro.directive.Directive.NotSimpleVariableBuildException

Directive.NotVariableBuildException - exception org.webmacro.directive.Directive.NotVariableBuildException.

Utility exception used by directives to signal that an argument that was supposed to be a Variable is not a variable.

Directive.NotVariableBuildException(String) - Constructor for class org.webmacro.directive.Directive.NotVariableBuildException

Directive.NotVariableBuildException(String, Exception) - Constructor for class org.webmacro.directive.Directive.NotVariableBuildException

Directive.OptionChoice - class org.webmacro.directive.Directive.OptionChoice.

The OptionChoice indicates that several optional groups can be accepted in any order.

Directive.OptionChoice(int) - Constructor for class org.webmacro.directive.Directive.OptionChoice

Directive.OptionalGroup - class org.webmacro.directive.Directive.OptionalGroup.

Optional group.

Directive.OptionalGroup(int) - Constructor for class org.webmacro.directive.Directive.OptionalGroup

Directive.OptionalRepeatingSubdirective - class org.webmacro.directive.Directive.OptionalRepeatingSubdirective.

Optional repeating subdirective.

Directive.OptionalRepeatingSubdirective(int, String, Directive.ArgDescriptor[]) - Constructor for class org.webmacro.directive.Directive.OptionalRepeatingSubdirective

Directive.OptionalRepeatingSubdirective(int, String, Directive.ArgDescriptor[], int) - Constructor for class org.webmacro.directive.Directive.OptionalRepeatingSubdirective

Directive.OptionalSubdirective - class org.webmacro.directive.Directive.OptionalSubdirective.

Optional subdirective.

Directive.OptionalSubdirective(int, String, Directive.ArgDescriptor[]) - Constructor for class org.webmacro.directive.Directive.OptionalSubdirective

Directive.OptionalSubdirective(int, String, Directive.ArgDescriptor[], int) - Constructor for class org.webmacro.directive.Directive.OptionalSubdirective

Directive.QuotedStringArg - class org.webmacro.directive.Directive.QuotedStringArg.

Quoted string argument type.

Directive.QuotedStringArg(int) - Constructor for class org.webmacro.directive.Directive.QuotedStringArg

Directive.RValueArg - class org.webmacro.directive.Directive.RValueArg.

RValue argument type.

Directive.RValueArg(int) - Constructor for class org.webmacro.directive.Directive.RValueArg

Directive.SingleOptionChoice - class org.webmacro.directive.Directive.SingleOptionChoice.

The SingleOptionChoice indicates that zero or one of several optional groups can be accepted, but only once.

Directive.SingleOptionChoice(int) - Constructor for class org.webmacro.directive.Directive.SingleOptionChoice

Directive.StringArg - class org.webmacro.directive.Directive.StringArg.

String argument type.

Directive.StringArg(int) - Constructor for class org.webmacro.directive.Directive.StringArg

Directive.Subdirective - class org.webmacro.directive.Directive.Subdirective.

Subdirectives are like directives, except that they do not have their own class.

Directive.Subdirective(int, String, Directive.ArgDescriptor[]) - Constructor for class org.webmacro.directive.Directive.Subdirective

Directive.Subdirective(int, String, Directive.ArgDescriptor[], int) - Constructor for class org.webmacro.directive.Directive.Subdirective

DirectiveArgs - interface org.webmacro.directive.DirectiveArgs.

Interface used for setting and retrieving directive arguments.

DirectiveBuilder - class org.webmacro.directive.DirectiveBuilder.

DirectiveBuilder manages the building of directives.

DirectiveBuilder(DirectiveDescriptor) - Constructor for class org.webmacro.directive.DirectiveBuilder

DirectiveDescriptor - class org.webmacro.directive.DirectiveDescriptor.

Each directive needs a DirectiveDescriptor to describe how it should be parsed and built by the parser.

DirectiveDescriptor(String, Class, Directive.ArgDescriptor[], Directive.Subdirective[]) - Constructor for class org.webmacro.directive.DirectiveDescriptor

DirectiveProvider - class org.webmacro.directive.DirectiveProvider.

Utility class to assist in the creation of directives.

DirectiveProvider() - Constructor for class org.webmacro.directive.DirectiveProvider

DollarReference() - Method in class org.webmacro.parser.WMParser_impl

Done() - Method in class org.webmacro.parser.ASCII_CharStream

Done() - Method in class org.webmacro.parser.BackupCharStream

Done() - Method in interface org.webmacro.parser.CharStream

The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.

DummyDirective - class org.webmacro.directive.DummyDirective.

A null directive implementation.

DummyDirective() - Constructor for class org.webmacro.directive.DummyDirective

date - Variable in class org.webmacro.engine.TestObject

debug(String, Throwable) - Method in interface org.webmacro.Log

Debug messages are incidental programmer notes which should not be enabled in a production system.

debug(String) - Method in interface org.webmacro.Log

A shortform for debug(msg,null)

debug(String, Throwable) - Method in class org.webmacro.util.LogSource

Debug messages are incidental programmer notes which should not be enabled in a production system.

debug(String) - Method in class org.webmacro.util.LogSource

A shortform for debug(msg,null)

debugStream - Variable in class org.webmacro.parser.WMParser_implTokenManager

decode(String) - Static method in class org.webmacro.util.Base64

Get the plain text version of a base64 encoded string

decode(byte[]) - Static method in class org.webmacro.util.Base64

Ge tthe plain text version of a base64 encoded byte array

decorate(String, CacheReloadContext) - Method in class org.webmacro.resource.ReloadDelayDecorator

Looks up the "check for reload delay" for protocol and creates a suitable TimedReloadContext or passes back the original reload context if delay <= 0

destroy() - Method in class org.webmacro.Broker

Close down this Broker.

destroy() - Method in interface org.webmacro.Provider

Close down this provider, freeing any allocated resources.

destroy() - Method in class org.webmacro.WM

Close down this WM.

destroy() - Method in interface org.webmacro.WebMacro

Destroy this WebMacro implementation which should de-allocate any resources that have been created inside the implementation of WebMacro.

destroy() - Method in class org.webmacro.directive.DirectiveProvider

destroy() - Method in class org.webmacro.engine.ParserProvider

destroy() - Method in interface org.webmacro.resource.CacheManager

Same as defined in Provider

destroy() - Method in class org.webmacro.resource.CachingProvider

Close down the provider.

destroy() - Method in class org.webmacro.resource.ConfigProvider

destroy() - Method in class org.webmacro.resource.ReloadingCacheManager

Close down the provider.

destroy() - Method in class org.webmacro.resource.SimpleCacheManager

Close down the provider.

destroy() - Method in class org.webmacro.resource.TrivialCacheManager

destroy() - Method in interface org.webmacro.servlet.Handler

You may use this method to save persistent state on exit.

destroy() - Method in class org.webmacro.servlet.WMServlet

This method is called by the servlet runner--do not call it.

destroy() - Method in class org.webmacro.util.EncoderProvider

Close down this provider, freeing any allocated resources.

destroy() - Method in class org.webmacro.util.WMEval

Free up resources when no longer needed.

destroyContext(WebContext) - Method in class org.webmacro.servlet.WMServlet

This method is called at the end of a request and is responsible for cleaning up the Context at the end of the request.

dirClass - Variable in class org.webmacro.directive.DirectiveDescriptor

directiveOk() - Method in class org.webmacro.parser.ParserBlockBuilder

disable_tracing() - Method in class org.webmacro.parser.WMParser_impl

divide(Number, Number) - Static method in class org.webmacro.servlet.MathTool

Converts args to doubles and divides the first by the second.

doEndTag() - Method in class org.webmacro.adapter.jsp.TemplateTag

Called when the end of the wm:template tag is found.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.TemplateServlet

Calls locateTemplate() and then getTemplate(), a base method, to find the template and render it.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.WMServlet

Process an incoming GET request: Builds a WebContext up and then passes it to the handle() method.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.TemplateServlet

Calls locateTemplate() and then getTemplate(), a base method, to find the template and render it.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.WMServlet

Behaves exactly like doGet() except that it reads data from POST before doing exactly the same thing.

doResponse(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.TemplateServlet

Method which prepares the response and sends it.

doStartTag() - Method in class org.webmacro.adapter.jsp.TemplateTag

Called when the wm:template tag starts.

E

END - Static variable in interface org.webmacro.parser.WMParser_implConstants

EOF - Static variable in interface org.webmacro.parser.WMParser_implConstants

ERROR - Static variable in class org.webmacro.util.LogSystem

EatWsNlIfNl(BlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

EatWsNlOrSpace(BlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

Encoder - class org.webmacro.util.Encoder.

An encoder is used to encode strings into a particular encoding in preparation for sending the data as part of a response.

Encoder(String) - Constructor for class org.webmacro.util.Encoder

Creates an encoder instance with the supplied encoding.

Encoder.Block - class org.webmacro.util.Encoder.Block.

The block class provides a means by which encoder users can encode entire blocks of text at once (and have those encoded blocks cached).

Encoder.Block(String[]) - Constructor for class org.webmacro.util.Encoder.Block

EncoderProvider - class org.webmacro.util.EncoderProvider.

A provider which dispenses Encoders, which are used for encoding Strings and caching the results.

EncoderProvider() - Constructor for class org.webmacro.util.EncoderProvider

EncodingCache - class org.webmacro.util.EncodingCache.

Provides for a cache of encodings of strings.

EncodingCache(String) - Constructor for class org.webmacro.util.EncodingCache

EncodingCache(String, int) - Constructor for class org.webmacro.util.EncodingCache

Create a new EncodingCache with space for buckets * length encoded strings.

EnumIterator - class org.webmacro.util.EnumIterator.

Allow a Java 1.1 enumeration to be used as a JDK 1.2 style Iterator

EnumIterator(Enumeration) - Constructor for class org.webmacro.util.EnumIterator

Construct an iterator given an enumeration

Eval - class org.webmacro.util.Eval.

Eval.java - static class with one method eval which just returns its argument.

EvalDirective - class org.webmacro.directive.EvalDirective.

Evaluate an instance of a webmacro target.

EvalDirective() - Constructor for class org.webmacro.directive.EvalDirective

Creates a new instance of EvalDirective

EvalTemplates - class org.webmacro.tools.EvalTemplates.

EvalTemplates supports an ant task execution to evaluate a set of templates.

EvalTemplates() - Constructor for class org.webmacro.tools.EvalTemplates

EvaluationExceptionHandler - interface org.webmacro.engine.EvaluationExceptionHandler.

Expression - class org.webmacro.engine.Expression.

All WM expressions derive from this base class.

Expression() - Constructor for class org.webmacro.engine.Expression

Expression() - Method in class org.webmacro.parser.WMParser_impl

Expression.AddBuilder - class org.webmacro.engine.Expression.AddBuilder.

Expression.AddBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.AddBuilder

Expression.AddOperation - class org.webmacro.engine.Expression.AddOperation.

Expression.AddOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.AddOperation

Expression.AndBuilder - class org.webmacro.engine.Expression.AndBuilder.

Expression.AndBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.AndBuilder

Expression.AndOperation - class org.webmacro.engine.Expression.AndOperation.

Expression.AndOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.AndOperation

Expression.BinaryOperation - class org.webmacro.engine.Expression.BinaryOperation.

Expression.BinaryOperationBuilder - class org.webmacro.engine.Expression.BinaryOperationBuilder.

Expression.BinaryOperationBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.BinaryOperationBuilder

Expression.Compare - class org.webmacro.engine.Expression.Compare.

Expression.Compare(Object, Object) - Constructor for class org.webmacro.engine.Expression.Compare

Expression.CompareEq - class org.webmacro.engine.Expression.CompareEq.

Expression.CompareEq(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareEq

Expression.CompareEqBuilder - class org.webmacro.engine.Expression.CompareEqBuilder.

Expression.CompareEqBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareEqBuilder

Expression.CompareGe - class org.webmacro.engine.Expression.CompareGe.

Expression.CompareGe(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareGe

Expression.CompareGeBuilder - class org.webmacro.engine.Expression.CompareGeBuilder.

Expression.CompareGeBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareGeBuilder

Expression.CompareGt - class org.webmacro.engine.Expression.CompareGt.

Expression.CompareGt(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareGt

Expression.CompareGtBuilder - class org.webmacro.engine.Expression.CompareGtBuilder.

Expression.CompareGtBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareGtBuilder

Expression.CompareLe - class org.webmacro.engine.Expression.CompareLe.

Expression.CompareLe(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareLe

Expression.CompareLeBuilder - class org.webmacro.engine.Expression.CompareLeBuilder.

Expression.CompareLeBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareLeBuilder

Expression.CompareLt - class org.webmacro.engine.Expression.CompareLt.

Expression.CompareLt(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareLt

Expression.CompareLtBuilder - class org.webmacro.engine.Expression.CompareLtBuilder.

Expression.CompareLtBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareLtBuilder

Expression.CompareNe - class org.webmacro.engine.Expression.CompareNe.

Expression.CompareNe(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareNe

Expression.CompareNeBuilder - class org.webmacro.engine.Expression.CompareNeBuilder.

Expression.CompareNeBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.CompareNeBuilder

Expression.DivideBuilder - class org.webmacro.engine.Expression.DivideBuilder.

Expression.DivideBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.DivideBuilder

Expression.DivideOperation - class org.webmacro.engine.Expression.DivideOperation.

Expression.DivideOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.DivideOperation

Expression.ExpressionBase - class org.webmacro.engine.Expression.ExpressionBase.

Expression.ExpressionBase() - Constructor for class org.webmacro.engine.Expression.ExpressionBase

Expression.MultiplyBuilder - class org.webmacro.engine.Expression.MultiplyBuilder.

Expression.MultiplyBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.MultiplyBuilder

Expression.MultiplyOperation - class org.webmacro.engine.Expression.MultiplyOperation.

Expression.MultiplyOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.MultiplyOperation

Expression.NotBuilder - class org.webmacro.engine.Expression.NotBuilder.

Expression.NotBuilder(Object) - Constructor for class org.webmacro.engine.Expression.NotBuilder

Expression.NotOperation - class org.webmacro.engine.Expression.NotOperation.

Expression.NotOperation(Object) - Constructor for class org.webmacro.engine.Expression.NotOperation

Expression.OrBuilder - class org.webmacro.engine.Expression.OrBuilder.

Expression.OrBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.OrBuilder

Expression.OrOperation - class org.webmacro.engine.Expression.OrOperation.

Expression.OrOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.OrOperation

Expression.SubtractBuilder - class org.webmacro.engine.Expression.SubtractBuilder.

Expression.SubtractBuilder(Object, Object) - Constructor for class org.webmacro.engine.Expression.SubtractBuilder

Expression.SubtractOperation - class org.webmacro.engine.Expression.SubtractOperation.

Expression.SubtractOperation(Object, Object) - Constructor for class org.webmacro.engine.Expression.SubtractOperation

Expression.UnaryOperation - class org.webmacro.engine.Expression.UnaryOperation.

Expression.UnaryOperationBuilder - class org.webmacro.engine.Expression.UnaryOperationBuilder.

Expression.UnaryOperationBuilder(Object) - Constructor for class org.webmacro.engine.Expression.UnaryOperationBuilder

eatLeadingWsNl() - Method in class org.webmacro.parser.ParserBlockBuilder

eatOneWs() - Method in class org.webmacro.parser.ParserBlockBuilder

eatTrailingWs() - Method in class org.webmacro.parser.ParserBlockBuilder

eatTrailingWsNl() - Method in class org.webmacro.parser.ParserBlockBuilder

eatTrailingWsNlWs() - Method in class org.webmacro.parser.ParserBlockBuilder

elementAt(int) - Method in class org.webmacro.engine.BlockBuilder

elements() - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

enable_tracing() - Method in class org.webmacro.parser.WMParser_impl

encode(String) - Method in class org.webmacro.servlet.URLTool.URLToolImpl

encode(String) - Static method in class org.webmacro.util.Base64

Get the base64 encoded version of a plain text String

encode(byte[]) - Static method in class org.webmacro.util.Base64

Get the base64 encoded version of a plain text byte array

encode(String) - Method in class org.webmacro.util.Encoder

Encodes the supplied string using the encoding bound to this encoder at construct time.

encode(Encoder.Block) - Method in class org.webmacro.util.Encoder

Encodes the supplied block of strings using the encoding bound to this encoder at construct time.

encode(String) - Method in class org.webmacro.util.EncodingCache

encode(String[]) - Method in class org.webmacro.util.EncodingCache

encode(String[], int) - Method in class org.webmacro.util.EncodingCache

endBlock() - Method in class org.webmacro.TemplateVisitor

endBlock() - Method in class org.webmacro.engine.TemplateDumper

endColumn - Variable in class org.webmacro.parser.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endDirective() - Method in class org.webmacro.TemplateVisitor

endLine - Variable in class org.webmacro.parser.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

ensureCapacity(int) - Method in class org.webmacro.util.ByteBufferOutputStream

Make sure the buffer contains space for len more bytes.

entrySet() - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

eol - Variable in class org.webmacro.parser.ParseException

The end of line string for this machine.

equals(Object) - Method in class org.webmacro.servlet.ServletBroker.PropertiesPair

equals(Object) - Method in class org.webmacro.util.Encoder.Block

error(String) - Method in interface org.webmacro.Log

A shortform for debug(msg,null)

error(String, Throwable) - Method in interface org.webmacro.Log

An error is a major failure within the system.

error(WebContext, String) - Method in class org.webmacro.servlet.WMServlet

Create an error template using the built in error handler.

error(String) - Method in class org.webmacro.util.LogSource

A shortform for error(msg,null)

error(String, Throwable) - Method in class org.webmacro.util.LogSource

An error is a major failure within the system.

error(String, Exception) - Method in class org.webmacro.util.WMEval

errorString(String) - Method in class org.webmacro.engine.CrankyEvaluationExceptionHandler

errorString(String) - Method in class org.webmacro.engine.DebugEvaluationExceptionHandler

errorString(String) - Method in class org.webmacro.engine.DefaultEvaluationExceptionHandler

errorString(String) - Method in interface org.webmacro.engine.EvaluationExceptionHandler

escape(String) - Static method in class org.webmacro.util.HTMLEscaper

This method will take the input and escape characters that have an HTML entity representation.

eval() - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

Evaluates the macro's template against its context and returns the resulting string.

eval(Object[]) - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

eval(Object[], Object[]) - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

eval(Map) - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

eval(Object) - Static method in class org.webmacro.util.Eval

eval() - Method in class org.webmacro.util.WMEval

Evaluates the context of this instance and the instance's current template and current output stream using UTF8.

eval(Context) - Method in class org.webmacro.util.WMEval

Evaluate the context supplied against the current template.

eval(Context, String, OutputStream) - Method in class org.webmacro.util.WMEval

Evaluates the string template against the current context and returns the value.

eval(String) - Method in class org.webmacro.util.WMEval

Evaluates the string template against the current context and returns the value.

eval(WebContext, String, HttpServletResponse) - Method in class org.webmacro.util.WMEval

Evaluates the string template against a new context and writes it to the http Response output stream using the proper encoding.

eval(Context, Template) - Method in class org.webmacro.util.WMEval

Evaluate the supplied context and template and return the result as a as a string.

eval(Context, String, OutputStream, String) - Method in class org.webmacro.util.WMEval

Evaluates the context using a file template sending the output to a disk file.

eval(Context, String, String, boolean, String) - Method in class org.webmacro.util.WMEval

Evaluates the current context for the input file and writes it to the output file.

eval(String) - Method in class org.webmacro.util.WMStringEval

Evaluate the template using the current context.

evaluate(Context) - Method in interface org.webmacro.Macro

same as out but returns a String

evaluate(Context) - Method in class org.webmacro.directive.Directive

evaluate(Context) - Method in class org.webmacro.directive.TypeDirective

Ensure the class of the specified Variable reference isAssignableFrom from the classname arg.

evaluate(Context) - Method in class org.webmacro.engine.Block

same as out but returns a String

evaluate(Variable, Context, Exception) - Method in class org.webmacro.engine.CrankyEvaluationExceptionHandler

evaluate(Variable, Context, Exception) - Method in class org.webmacro.engine.DebugEvaluationExceptionHandler

evaluate(Variable, Context, Exception) - Method in class org.webmacro.engine.DefaultEvaluationExceptionHandler

evaluate(Variable, Context, Exception) - Method in interface org.webmacro.engine.EvaluationExceptionHandler

When an exception is detected in the process of evaluating a variable reference, this method is consulted.

evaluate(Context) - Method in class org.webmacro.engine.Expression.AndOperation

evaluate(Context) - Method in class org.webmacro.engine.Expression.BinaryOperation

evaluate(Context) - Method in class org.webmacro.engine.Expression.OrOperation

evaluate(Context) - Method in class org.webmacro.engine.Expression.UnaryOperation

evaluate(Context) - Method in class org.webmacro.engine.MacroAdapter

Returns the wrapped object, context is ignored.

evaluate(Context) - Method in class org.webmacro.engine.StringMacro

evaluate(Context) - Method in class org.webmacro.engine.StringMacroAdapter

Returns the wrapped object, context is ignored.

evaluate(Context) - Method in class org.webmacro.engine.UndefinedMacro

Returns the wrapped object, context is ignored.

evaluate(Context) - Method in class org.webmacro.engine.Variable

Looks in the hashTable (context) for a value keyed to this variables name and returns the value string.

evaluate(Context) - Method in class org.webmacro.engine.VoidMacro

Always throws a new PropertyException.VoidValueException

evaluateAsBytes(String, Context) - Method in interface org.webmacro.Template

evaluateAsBytes(String, Context) - Method in class org.webmacro.engine.WMTemplate

Parse the Template against the supplied context data and return it as a byte array.

evaluateAsString(Context) - Method in interface org.webmacro.Template

evaluateAsString(Context) - Method in class org.webmacro.engine.WMTemplate

Parse the Template against the supplied context data and return it as a string.

execute(Template, WebContext) - Method in class org.webmacro.servlet.WMServlet

This method takes a populated context and a template and writes out the interpreted template to the context's output stream.

execute() - Method in class org.webmacro.tools.WMTemplateAntTask

expand(Variable, Context, Exception) - Method in class org.webmacro.engine.CrankyEvaluationExceptionHandler

expand(Variable, Context, Exception) - Method in class org.webmacro.engine.DebugEvaluationExceptionHandler

expand(Variable, Context, Exception) - Method in class org.webmacro.engine.DefaultEvaluationExceptionHandler

expand(Variable, Context, Exception) - Method in interface org.webmacro.engine.EvaluationExceptionHandler

When an exception is detected in the process of expanding (writing) a variable reference, this method is consulted.

expand(Object[], BuildContext) - Method in class org.webmacro.engine.MacroDefinition

expectedTokenSequences - Variable in class org.webmacro.parser.ParseException

Each entry in this array is an array of integers.

F

FALSE - Static variable in interface org.webmacro.parser.WMParser_implConstants

FLOAT - Static variable in class org.webmacro.util.CastUtil

Factor() - Method in class org.webmacro.parser.WMParser_impl

FastWriter - class org.webmacro.FastWriter.

FastWriter attempts to optimize output speed in a WebMacro template through several specific optimizations: FastWriter caches the output in a byte array until you call reset().

FastWriter(Broker, OutputStream, String) - Constructor for class org.webmacro.FastWriter

Create a FastWriter to the target outputstream.

FastWriter(Broker, String) - Constructor for class org.webmacro.FastWriter

Create a new FastWriter with no output stream target.

FileTemplate - class org.webmacro.engine.FileTemplate.

FileTemplate objects read their template data from a text file.

FileTemplate(Broker, String) - Constructor for class org.webmacro.engine.FileTemplate

Instantiate a template based on the specified filename using the default encoding from WebMacro.properties (TemplateEncoding), or if not specified there then the UTF-8 encoding.

FileTemplate(Broker, File) - Constructor for class org.webmacro.engine.FileTemplate

Instantiate a template based on the specified file using the default encoding from WebMacro.properties (TemplateEncoding), if not specified there then the UTF-8 encoding.

FileTemplate(Broker, File, String) - Constructor for class org.webmacro.engine.FileTemplate

Instantiate a template based on the specified file using the specified encoding to read the template.

FileTemplateLoader - class org.webmacro.resource.FileTemplateLoader.

Implementation of TemplateLoader that loads templates from a given directory.

FileTemplateLoader() - Constructor for class org.webmacro.resource.FileTemplateLoader

Flags - class org.webmacro.Flags.

This class contains some static final settings which control the behavior of WebMacro at runtime.

ForeachDirective - class org.webmacro.directive.ForeachDirective.

Implements iteration through a list or an array with various options.

ForeachDirective() - Constructor for class org.webmacro.directive.ForeachDirective

Form - class org.webmacro.servlet.Form.

Provide access to form variables

FormList - class org.webmacro.servlet.FormList.

Provide access to form variables

FormListTool - class org.webmacro.servlet.FormListTool.

Provide Template with access to form data.

FormListTool() - Constructor for class org.webmacro.servlet.FormListTool

FormTool - class org.webmacro.servlet.FormTool.

Provide Template with access to form data.

FormTool() - Constructor for class org.webmacro.servlet.FormTool

FormalArgList() - Method in class org.webmacro.parser.WMParser_impl

FunctionCall - class org.webmacro.engine.FunctionCall.

Holder for standalone function calls $a($foo)

FunctionCall(String, Object[]) - Constructor for class org.webmacro.engine.FunctionCall

Create a new FunctionCall

FunctionCall(String, Macro) - Constructor for class org.webmacro.engine.FunctionCall

Create a new FunctionCall

FunctionCallBuilder - class org.webmacro.engine.FunctionCallBuilder.

Builder for standalone function calls $a($foo)

FunctionCallBuilder(String, ListBuilder) - Constructor for class org.webmacro.engine.FunctionCallBuilder

FunctionVariable - class org.webmacro.engine.FunctionVariable.

FunctionVariable(Object[]) - Constructor for class org.webmacro.engine.FunctionVariable

Creates a new instance of FunctionVariable

filesets - Variable in class org.webmacro.tools.WMTemplateAntTask

findBroker(Object) - Static method in class org.webmacro.Broker

Find the broker for the specified partition _key, if one is registered.

findWebMacro(ListableBeanFactory, ServletContext, ClassLoader) - Method in class org.webmacro.adapter.spring.WebMacroViewResolver

Attempt to load WebMacro instance from Spring application context, or fall back to a plain new WM() (note: no webapp classpath template loading!)

flush() - Method in class org.webmacro.FastWriter

Flush all data out to the OutputStream, if any, clearing the internal buffers.

flush() - Method in interface org.webmacro.Provider

Clear any cache this provider may be maintaining

flush() - Method in class org.webmacro.directive.DirectiveProvider

flush() - Method in class org.webmacro.engine.ParserProvider

flush() - Method in interface org.webmacro.resource.CacheManager

Same as defined in Provider

flush() - Method in class org.webmacro.resource.CachingProvider

Clear the cache.

flush() - Method in class org.webmacro.resource.ConfigProvider

flush() - Method in class org.webmacro.resource.ReloadingCacheManager

Clear the cache.

flush() - Method in class org.webmacro.resource.SimpleCacheManager

Clear the cache.

flush() - Method in class org.webmacro.resource.TrivialCacheManager

flush() - Method in class org.webmacro.servlet.ServletLog

flush() - Method in class org.webmacro.util.CommonsLoggingTarget

flush() - Method in class org.webmacro.util.EncoderProvider

Clear any cache this provider may be maintaining.

flush() - Method in class org.webmacro.util.LogFile

flush() - Method in class org.webmacro.util.LogSystem

Flush all of the LogTarget objects in the system

flush() - Method in interface org.webmacro.util.LogTarget

Flush the log.

fname - Variable in class org.webmacro.engine.TestObject

formatDate(Date, String) - Static method in class org.webmacro.servlet.TextTool

Format a java.util.Date object using the specified date format string.

fromFile(String) - Method in class org.webmacro.servlet.TemplateTool.MacroTemplateFactory

Creates a MacroTemplate from a file reference with a new context.

fromString(String) - Method in class org.webmacro.servlet.TemplateTool.MacroTemplateFactory

Creates a MacroTemplate from a string with a new context.

G

GetImage() - Method in class org.webmacro.parser.ASCII_CharStream

GetImage() - Method in class org.webmacro.parser.BackupCharStream

GetImage() - Method in interface org.webmacro.parser.CharStream

Returns a string made up of characters from the marked token beginning to the current buffer position.

GetSuffix(int) - Method in class org.webmacro.parser.ASCII_CharStream

GetSuffix(int) - Method in class org.webmacro.parser.BackupCharStream

GetSuffix(int) - Method in interface org.webmacro.parser.CharStream

Returns an array of characters that make up the suffix of length 'len' for the currently matched token.

GlobalDirective - class org.webmacro.directive.GlobalDirective.

Implements a directive supporting a global value.

GlobalDirective() - Constructor for class org.webmacro.directive.GlobalDirective

generateParseException() - Method in class org.webmacro.parser.WMParser_impl

get(String, String) - Method in class org.webmacro.Broker

Look up query against a provider using its integer type handle.

get(Object) - Method in class org.webmacro.Context

Get the named object/property from the Context; returns null if not found.

get(Context) - Method in class org.webmacro.ContextTool

get(String) - Method in interface org.webmacro.Provider

Get the object associated with the specified query

get(String, Context) - Method in interface org.webmacro.broker.ContextAutoLoader

Return a new instance of the named automatic variable

get(Context) - Method in interface org.webmacro.broker.ContextObjectFactory

Return an object which is suitable for placement in the context.

get(String, Context) - Method in class org.webmacro.broker.DefaultContextAutoLoader

get(String) - Method in class org.webmacro.directive.DirectiveProvider

The DirectiveProvider doesn't throw an exception when it can't find the directive -- it just returns null.

get(String) - Method in class org.webmacro.engine.ParserProvider

get() - Method in class org.webmacro.engine.StaticClassWrapper

get(Object) - Method in class org.webmacro.engine.UndefinedMacro

get(Object, ResourceLoader) - Method in interface org.webmacro.resource.CacheManager

Called to get a resource from the cache.

get(Object) - Method in interface org.webmacro.resource.CacheManager

Called to get a resource from the cache.

get(String) - Method in class org.webmacro.resource.CachingProvider

Get the object associated with the specific query, using the specified cache manager.

get(String) - Method in class org.webmacro.resource.ConfigProvider

get(Object, ResourceLoader) - Method in class org.webmacro.resource.ReloadingCacheManager

Get the object associated with the specific query, first trying to look it up in a cache.

get(Object) - Method in class org.webmacro.resource.ReloadingCacheManager

Get the object associated with the specific query, trying to look it up in a cache.

get(Object, ResourceLoader) - Method in class org.webmacro.resource.SimpleCacheManager

Get the object associated with the specific query, first trying to look it up in a cache.

get(Object) - Method in class org.webmacro.resource.SimpleCacheManager

Get the object associated with the specific query, trying to look it up in a cache.

get(Object, ResourceLoader) - Method in class org.webmacro.resource.TrivialCacheManager

get(Object) - Method in class org.webmacro.resource.TrivialCacheManager

get(String) - Method in class org.webmacro.servlet.CookieJar

Get a form value

get(String) - Method in class org.webmacro.servlet.Form

Get a form value

get(String) - Method in class org.webmacro.servlet.FormList

Get a form value

get(String) - Method in class org.webmacro.servlet.LocaleTool

access method used by $Locale.xxxxx => LocaleTool.get("xxxxx")

get(Object) - Method in class org.webmacro.servlet.VariableTool

Get the specified object name defined from the active Context.

get(String) - Method in interface org.webmacro.util.Bag

Get an item from the bag

get(Object) - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

get(String) - Method in class org.webmacro.util.EncoderProvider

Get the object associated with the specified query.

get(Object) - Method in class org.webmacro.util.SparseProperties

Gets the object but returns the default value if not present.

get(Object, Object) - Method in class org.webmacro.util.SparseProperties

Gets the object but returns the default value if not present.

getAUTH_TYPE() - Method in class org.webmacro.servlet.CGI_Impersonator

Type of authorization for this request

getAllowedPackages() - Method in class org.webmacro.util.Instantiator

getApplication() - Method in class org.webmacro.adapter.jsp.JSPAttributes

getArg(int) - Method in class org.webmacro.directive.ArgsHolder

Retrieve the argument whose id is the specified id.

getArg(int, BuildContext) - Method in class org.webmacro.directive.ArgsHolder

Retrieve the argument whose id is the specified id, and if it is a Builder, build it with the specified build context.

getArg(int) - Method in interface org.webmacro.directive.DirectiveArgs

getArg(int, BuildContext) - Method in interface org.webmacro.directive.DirectiveArgs

getArg(int) - Method in class org.webmacro.directive.DirectiveBuilder

Retrieve the argument whose id is the specified id.

getArg(int, BuildContext) - Method in class org.webmacro.directive.DirectiveBuilder

Retrieve the argument whose id is the specified id, and if it is a Builder, build it with the specified build context.

getArgCount() - Method in class org.webmacro.directive.ArgsHolder

How many arguments does this ArgsHolder have?

getArgCount() - Method in interface org.webmacro.directive.DirectiveArgs

getArgCount() - Method in class org.webmacro.directive.DirectiveBuilder

How many arguments does this builder have?

getArgNames() - Method in class org.webmacro.engine.MacroDefinition

getArgs() - Method in class org.webmacro.servlet.TemplateTool.MacroTemplate

Exposes the context of the current MacroTemplate.

getArguments(Context) - Method in class org.webmacro.util.PropertyMethod

Return the arguments for this method, after resolving them against the supplied context.

getAsProperties() - Method in class org.webmacro.util.Settings

Get the values from this settings object as a properties

getAutoContextVariable(String, Context) - Method in class org.webmacro.Broker

Fetch a tool

getBeginColumn() - Method in class org.webmacro.parser.ASCII_CharStream

getBeginColumn() - Method in class org.webmacro.parser.BackupCharStream

getBeginColumn() - Method in interface org.webmacro.parser.CharStream

Returns the column number of the first character for current token (being matched after the last call to BeginTOken).

getBeginLine() - Method in class org.webmacro.parser.ASCII_CharStream

getBeginLine() - Method in class org.webmacro.parser.BackupCharStream

getBeginLine() - Method in interface org.webmacro.parser.CharStream

Returns the line number of the first character for current token (being matched after the last call to BeginTOken).

getBlockIterator() - Method in class org.webmacro.engine.Block

getBooleanSetting(String) - Method in class org.webmacro.Broker

Access to the settings in WebMacro.properties

getBooleanSetting(String) - Method in class org.webmacro.util.Settings

Get a setting and convert it to a boolean.

getBooleanSetting(String, boolean) - Method in class org.webmacro.util.Settings

Get a setting with a default value in case it is not set

getBroker() - Static method in class org.webmacro.Broker

getBroker(Properties) - Static method in class org.webmacro.Broker

getBroker(String) - Static method in class org.webmacro.Broker

getBroker() - Method in class org.webmacro.Context

Get the instance of the Broker for this request

getBroker() - Method in class org.webmacro.WM

This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.

getBroker() - Method in interface org.webmacro.WebMacro

This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.

getBroker(Servlet, Properties) - Static method in class org.webmacro.servlet.Servlet20Broker

Get a Servlet API 2.0 compatible broker for the Servlet specified

getBroker(ServletContext, ClassLoader, Properties) - Static method in class org.webmacro.servlet.Servlet20Broker

Get a Servlet API 2.0 compatible broker for the ServletContext specified

getBroker(Servlet, Properties) - Static method in class org.webmacro.servlet.Servlet22Broker

getBroker(ServletContext, ClassLoader, Properties) - Static method in class org.webmacro.servlet.Servlet22Broker

Get a Servlet API 2.2 compatible broker for the ServletContext specified

getBroker(Servlet, Properties) - Static method in class org.webmacro.servlet.ServletBroker

getBroker(ServletContext, ClassLoader, Properties) - Static method in class org.webmacro.servlet.ServletBroker

Get a Broker according to Servlet API version, when no Servlet reference is available.

getBroker(Servlet) - Static method in class org.webmacro.servlet.ServletBroker

getBroker() - Method in class org.webmacro.servlet.WMServlet

This object is used to access components that have been plugged into WebMacro; it is shared between all instances of this class and its subclasses.

getBrokerLocal(Object) - Method in class org.webmacro.Broker

Get a value that was previously stored in this Broker.

getBrokerLog() - Method in class org.webmacro.Broker

Provide access to the broker's log.

getBuffer() - Method in class org.webmacro.util.ByteBufferOutputStream

Get the bytes in the buffer.

getBytes() - Method in class org.webmacro.util.ByteBufferOutputStream

Allocate a new byte[] and fill it with the contents of the current byte buffer.

getCGI() - Method in class org.webmacro.servlet.WebContext

Get the CGI Tool

getCONTENT_LENGTH() - Method in class org.webmacro.servlet.CGI_Impersonator

Get the content length submitted to this request

getCONTENT_TYPE() - Method in class org.webmacro.servlet.CGI_Impersonator

Get the content type submitted to this request

getCategory() - Method in class org.webmacro.util.LogSource

The category for this log source, as it woudl print in the log.

getCaught() - Method in class org.webmacro.RethrowableException

Deprecated. you should use getCause instead

getCaught() - Method in class org.webmacro.RethrowableRuntimeException

Deprecated. you should use getCause instead

getCause() - Method in class org.webmacro.RethrowableException

Return the underlying exception provided at construction time or null if none was provided.

getCause() - Method in class org.webmacro.RethrowableRuntimeException

Return the underlying exception provided at construction time or null if none was provided.

getClassLoader() - Method in class org.webmacro.Broker

getClasspath() - Method in class org.webmacro.tools.WMTemplateAntTask

getColNo(int) - Method in class org.webmacro.engine.Block

getColNo() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

getColNo() - Method in interface org.webmacro.engine.BlockBuilder.BlockIterator

getColumn() - Method in class org.webmacro.parser.ASCII_CharStream

Deprecated.

getColumn() - Method in class org.webmacro.parser.BackupCharStream

Deprecated.

getColumn() - Method in interface org.webmacro.parser.CharStream

Deprecated.

getCompleteRequestURL() - Method in class org.webmacro.servlet.URLTool.URLToolImpl

Return the complete url, that was uses to access this page including path_info and query_string if present.

getConfig(String) - Method in class org.webmacro.WM

Retrieve configuration information from the "config" provider.

getConfig(String) - Method in interface org.webmacro.WebMacro

Retrieve configuration information from the "config" provider.

getConfig(String) - Method in class org.webmacro.servlet.WMServlet

Retrieve configuration information from the "config" provider.

getConfig(String, String) - Method in class org.webmacro.servlet.WMServlet

Retrieve configuration information from the "config" provider.

getContext() - Method in class org.webmacro.WM

Instantiate a new context.

getContext() - Method in interface org.webmacro.WebMacro

Create a new Context.

getContext() - Method in class org.webmacro.adapter.jsp.TemplateTag

getContext() - Method in class org.webmacro.servlet.WMServlet

Create a new Context object

getContextElement(String) - Method in class org.webmacro.tools.EvalTemplates

After a template has been run, this method will return an object in the context by name.

getContextLocation() - Method in class org.webmacro.WebMacroException

getCookie(String) - Method in class org.webmacro.servlet.WebContext

get a cookie from the request

getCurrentContext() - Method in class org.webmacro.util.WMEval

Gets the current context.

getCurrentContext() - Method in class org.webmacro.util.WMStringEval

Gets the current context.

getCurrentLocation() - Method in class org.webmacro.Context

getCurrentTemplate() - Method in class org.webmacro.util.WMEval

Gets the current template.

getDOCUMENT_ROOT() - Method in class org.webmacro.servlet.CGI_Impersonator

What is the root of documents served by this servlet WARNING: the method called (getRealPath) is deprecated in Servlet 2.2

getDate() - Static method in class org.webmacro.util.Clock

The current date.

getDefault() - Method in class org.webmacro.servlet.LocaleTool

return the default locale for this JVM

getDefaultEncoding() - Method in class org.webmacro.engine.WMTemplate

return the default encoding either from the WebMacro config or the JVM settings Note for Unix users: you may need to set the environmental variable LC_ALL=[locale] to get the default one set up.

getDescription() - Method in class org.webmacro.engine.MethodWrapper

getDescription() - Method in class org.webmacro.util.LogSource

Get a description of this log source: what kind of messages does it contain.

getDescriptor() - Static method in class org.webmacro.directive.AlternateDirective

getDescriptor() - Static method in class org.webmacro.directive.AttributeDirective

getDescriptor() - Static method in class org.webmacro.directive.BeanDirective

getDescriptor() - Static method in class org.webmacro.directive.CommentDirective

getDescriptor() - Static method in class org.webmacro.directive.CountDirective

getDescriptor() - Static method in class org.webmacro.directive.DefaultDirective

getDescriptor() - Static method in class org.webmacro.directive.DummyDirective

getDescriptor() - Static method in class org.webmacro.directive.EvalDirective

getDescriptor() - Static method in class org.webmacro.directive.ForeachDirective

getDescriptor() - Static method in class org.webmacro.directive.GlobalDirective

getDescriptor() - Static method in class org.webmacro.directive.IncludeDirective

getDescriptor() - Static method in class org.webmacro.directive.MacroDirective

getDescriptor() - Static method in class org.webmacro.directive.ParamDirective

getDescriptor() - Static method in class org.webmacro.directive.SetDirective

getDescriptor() - Static method in class org.webmacro.directive.SetblockDirective

getDescriptor() - Static method in class org.webmacro.directive.SetpropsDirective

getDescriptor() - Static method in class org.webmacro.directive.TempletDirective

Returns the descriptor for this directive

getDescriptor() - Static method in class org.webmacro.directive.TextDirective

getDescriptor() - Static method in class org.webmacro.directive.TypeDirective

static method required by the WebMacro parser to provide a descriptor about this directive

getEncoder() - Method in class org.webmacro.FastWriter

Get the encoder used by this FastWriter to transform char[] data into byte[] data.

getEncoding() - Method in class org.webmacro.FastWriter

Get the character encoding this FastWriter uses to convert characters to byte[]

getEncodingName() - Method in class org.webmacro.util.EncodingCache

getEndColumn() - Method in class org.webmacro.parser.ASCII_CharStream

getEndColumn() - Method in class org.webmacro.parser.BackupCharStream

getEndColumn() - Method in interface org.webmacro.parser.CharStream

Returns the column number of the last character for current token (being matched after the last call to BeginTOken).

getEndLine() - Method in class org.webmacro.parser.ASCII_CharStream

getEndLine() - Method in class org.webmacro.parser.BackupCharStream

getEndLine() - Method in interface org.webmacro.parser.CharStream

Returns the line number of the last character for current token (being matched after the last call to BeginTOken).

getErrorTemplate() - Method in class org.webmacro.servlet.WMServlet

Gets a template for displaying an error message.

getErrorTemplateName() - Method in class org.webmacro.servlet.WMServlet

getErrorVariableName() - Method in class org.webmacro.servlet.WMServlet

Returns the name of the error variable, as per the config.

getEvaluationExceptionHandler() - Method in class org.webmacro.Broker

Get the EvaluationExceptionHandler

getEvaluationExceptionHandler() - Method in class org.webmacro.Context

Get the EvaluationExceptionHandler

getExactArg(int) - Method in class org.webmacro.directive.ArgsHolder

Get the argument at the specified index.

getExactArg(int) - Method in interface org.webmacro.directive.DirectiveArgs

getExactArg(int) - Method in class org.webmacro.directive.DirectiveBuilder

getFastWriter(OutputStream, String) - Method in class org.webmacro.Broker

Deprecated.

getFastWriter(OutputStream, String) - Method in class org.webmacro.WM

Deprecated.

getFastWriter(OutputStream, String) - Method in interface org.webmacro.WebMacro

Deprecated.

getFastWriter(OutputStream, String) - Method in class org.webmacro.servlet.WMServlet

Deprecated.

getFile(Broker, String) - Method in class org.webmacro.directive.IncludeDirective

get the contents of a file (local file or url) via the "url" provider known by the specified broker.

getForm(String) - Method in class org.webmacro.servlet.WebContext

Get the value of a form variable from the request

getFormList(String) - Method in class org.webmacro.servlet.WebContext

Get the value of a form variable from the request as an array

getFunction(String) - Method in class org.webmacro.Broker

fetch a "global function"

getHTTP_ACCEPT() - Method in class org.webmacro.servlet.CGI_Impersonator

What type of data is accepted by the client

getHTTP_REFERER() - Method in class org.webmacro.servlet.CGI_Impersonator

Get the URL that the request claims to have visited prior to this one

getHTTP_USER_AGENT() - Method in class org.webmacro.servlet.CGI_Impersonator

Get the user agent (browser) connected to this request

getImpliedPackages() - Method in class org.webmacro.util.Instantiator

getInstance(Broker, OutputStream, String) - Static method in class org.webmacro.FastWriter

Get a new FastWriter.

getInstance(Broker, OutputStream) - Static method in class org.webmacro.FastWriter

Get a new FastWriter.

getInstance(Broker, String) - Static method in class org.webmacro.FastWriter

Return a FastWriter with the specified encoding and no output stream.

getInstance(Broker) - Static method in class org.webmacro.FastWriter

Return a FastWriter with default encoding and no output stream.

getInstance() - Static method in class org.webmacro.engine.UndefinedMacro

getInstance() - Static method in class org.webmacro.servlet.ListUtil

getInstance() - Static method in class org.webmacro.servlet.MathTool

getInstance() - Static method in class org.webmacro.servlet.TextTool

getInstance() - Static method in class org.webmacro.util.CastUtil

getInstance(String) - Static method in class org.webmacro.util.EncodingCache

getInstance(Broker) - Static method in class org.webmacro.util.Instantiator

getInstance() - Static method in class org.webmacro.util.LogSystem

Get the global, system-wide, default log system

getInstance() - Static method in class org.webmacro.util.LogTargetFactory

return the only instance of this LogTargetFactory

getIntegerSetting(String) - Method in class org.webmacro.Broker

Access to the settings in WebMacro.properties

getIntegerSetting(String, int) - Method in class org.webmacro.Broker

Access to the settings in WebMacro.properties

getIntegerSetting(String) - Method in class org.webmacro.util.Settings

Get a setting and convert it to an int

getIntegerSetting(String, int) - Method in class org.webmacro.util.Settings

Get a setting with a default value in case it is not set

getIsValid() - Method in class org.webmacro.engine.TestObject

getItem(Object[], int) - Static method in class org.webmacro.servlet.ListUtil

Allows access to elements in an array by position.

getItem(List, int) - Static method in class org.webmacro.servlet.ListUtil

Allows access to elements in a List by position.

getItem(Object, int) - Static method in class org.webmacro.servlet.ListUtil

Allows access to elements in a array of primitives by position.

getIterator(Object) - Method in class org.webmacro.engine.PropertyOperatorCache

Evaluate the supplied object and work out a way to return it as an iterator.

getKeys() - Method in class org.webmacro.util.Settings

Get the keys for this settings object as an array

getKeys() - Method in class org.webmacro.util.SubSettings

getLevel(String) - Static method in class org.webmacro.util.LogSystem

Convert a string like "DEBUG" into a level number.

getLine() - Method in class org.webmacro.parser.ASCII_CharStream

Deprecated.

getLine() - Method in class org.webmacro.parser.BackupCharStream

Deprecated.

getLine() - Method in interface org.webmacro.parser.CharStream

Deprecated.

getLineNo(int) - Method in class org.webmacro.engine.Block

getLineNo() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

getLineNo() - Method in interface org.webmacro.engine.BlockBuilder.BlockIterator

getLines(String) - Static method in class org.webmacro.servlet.TextTool

converts a block of text into an array of strings by tokenizing using \r\n as the delimiter If no \r\n, it will look for \n or \r and use them instead.

getList(String) - Method in class org.webmacro.servlet.Form

Get a form value as an array

getLocale(String) - Method in class org.webmacro.servlet.LocaleTool

wrappers around the 3 constructors for Locale

getLocale(String, String) - Method in class org.webmacro.servlet.LocaleTool

getLocale(String, String, String) - Method in class org.webmacro.servlet.LocaleTool

getLog(String, String) - Method in class org.webmacro.Broker

Get a log: the behavior of this log depends on the configuration of the broker.

getLog(String) - Method in class org.webmacro.Broker

Shortcut: create a new log using the type as the description

getLog(String, String) - Method in class org.webmacro.Context

Get a log instance that can be used to write log messages into the log under the supplied log type.

getLog(String) - Method in class org.webmacro.Context

Get a log instance that can be used to write log messages into the log under the supplied log type.

getLog(String, String) - Method in class org.webmacro.WM

Get a log to write information to.

getLog(String) - Method in class org.webmacro.WM

Get a log using the type as the description

getLog(String, String) - Method in interface org.webmacro.WebMacro

Get a log to write information to.

getLog(String) - Method in interface org.webmacro.WebMacro

Get a log using the type as the description

getLog(String, String) - Method in class org.webmacro.servlet.WMServlet

Get a Log object which can be used to write to the log file.

getLog(String) - Method in class org.webmacro.servlet.WMServlet

Get a Log object which can be used to write to the log file.

getLog(String) - Method in class org.webmacro.util.LogSystem

Get an instance of a Log object for the specified type.

getLog(String, String) - Method in class org.webmacro.util.LogSystem

Get the Log object within this LogSystem that has the specified Log type.

getLog() - Method in class org.webmacro.util.WMEval

Return the log associated with this instance of WMEval.

getMacro(String) - Method in class org.webmacro.engine.BuildContext

Search for a MacroDefinition in the build context

getMacro(String) - Method in class org.webmacro.engine.MacroBuildContext

getMacroBody() - Method in class org.webmacro.engine.MacroDefinition

getMacros() - Method in class org.webmacro.Broker

Return a map of all global macros.

getMacros() - Method in interface org.webmacro.Template

Get a Map containing all #macros defined for this template.

getMacros() - Method in class org.webmacro.engine.BuildContext

Return the map of MacroDefinitions

getMacros() - Method in class org.webmacro.engine.WMTemplate

Get the #macros' defined for this template.

getMainClass() - Method in class org.webmacro.tools.TemplateEvalAntTask

Returns org.webmacro.tools.EvalTemplates

getMainClass() - Method in class org.webmacro.tools.WMTemplateAntTask

Subclasses should override this to supply their own template execution vehicle.

getMap() - Method in class org.webmacro.Context

Get the underlying Map object.

getMessage() - Method in class org.webmacro.PropertyException.UndefinedVariableException

Overloaded to return the reason specified during construction plus the context location, if any.

getMessage() - Method in class org.webmacro.PropertyException

getMessage() - Method in class org.webmacro.WebMacroException

Overloaded to return the reason specified during construction plus the context location, if any.

getMessage() - Method in class org.webmacro.parser.ParseException

This method has the standard behavior when this object has been created using the standard constructors.

getMessage() - Method in class org.webmacro.parser.TokenMgrError

You can also modify the body of this method to customize your error messages.

getName() - Method in class org.webmacro.Broker

getName() - Method in interface org.webmacro.Template

getName() - Method in class org.webmacro.directive.DirectiveBuilder

Get the name this directive was registered as

getName() - Method in class org.webmacro.engine.Argument

Return the action code for this predicate

getName() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

getName() - Method in interface org.webmacro.engine.BlockBuilder.BlockIterator

getName() - Method in class org.webmacro.engine.Expression.AddOperation

getName() - Method in class org.webmacro.engine.Expression.BinaryOperation

getName() - Method in class org.webmacro.engine.Expression.CompareEq

getName() - Method in class org.webmacro.engine.Expression.CompareGe

getName() - Method in class org.webmacro.engine.Expression.CompareGt

getName() - Method in class org.webmacro.engine.Expression.CompareLe

getName() - Method in class org.webmacro.engine.Expression.CompareLt

getName() - Method in class org.webmacro.engine.Expression.CompareNe

getName() - Method in class org.webmacro.engine.Expression.DivideOperation

getName() - Method in class org.webmacro.engine.Expression.MultiplyOperation

getName() - Method in class org.webmacro.engine.Expression.NotOperation

getName() - Method in class org.webmacro.engine.Expression.SubtractOperation

getName() - Method in class org.webmacro.engine.Expression.UnaryOperation

getName() - Method in class org.webmacro.engine.FileTemplate

getName() - Method in class org.webmacro.engine.MacroDefinition

getName() - Method in class org.webmacro.engine.StreamTemplate

getName() - Method in class org.webmacro.engine.StringTemplate

getName() - Method in class org.webmacro.engine.TestObject

getName() - Method in class org.webmacro.engine.Variable

Like getPropertyNames, but only works if isSimpleName is true

getName() - Method in class org.webmacro.engine.WMTemplate

Return a name for this template.

getName() - Method in interface org.webmacro.util.Named

getName() - Method in class org.webmacro.util.PropertyMethod

Return the name of this PropertyMethod

getNewContext() - Method in class org.webmacro.util.WMEval

Provides for a new context to be established.

getNewContext(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.util.WMEval

getNewContext() - Method in class org.webmacro.util.WMStringEval

Establish a new context for future evaluations.

getNextToken() - Method in class org.webmacro.parser.WMParser_impl

getNextToken() - Method in class org.webmacro.parser.WMParser_implTokenManager

getOperator(Class) - Method in class org.webmacro.engine.PropertyOperatorCache

getOperator(Object) - Method in class org.webmacro.engine.PropertyOperatorCache

getOutputStream() - Method in class org.webmacro.FastWriter

Get the output stream this FastWriter sends output to.

getPATH_INFO() - Method in class org.webmacro.servlet.CGI_Impersonator

What portion of the URL appeared as additional path beyond the SCRIPT_NAME portion.

getPATH_TRANSLATED() - Method in class org.webmacro.servlet.CGI_Impersonator

Same as PATH_INFO but translated to a real path

getPage() - Method in class org.webmacro.adapter.jsp.JSPAttributes

getParam(String) - Method in interface org.webmacro.Template

A template may contain parameters, set by the #param directive.

getParam(String) - Method in class org.webmacro.engine.WMTemplate

Template API

getParameters() - Method in interface org.webmacro.Template

getParameters() - Method in class org.webmacro.engine.WMTemplate

getParser(String) - Method in class org.webmacro.engine.BuildContext

getParser(String) - Method in class org.webmacro.engine.ParserProvider

getParser() - Method in class org.webmacro.engine.WMTemplate

Subclasses can override this if they wish to invoke a parser other than the WM parser, or choose the parser on some more complicated condition.

getParserName() - Method in class org.webmacro.parser.WMParser

Return a short name that identifies this parser.

getPossibleForm(String) - Method in class org.webmacro.servlet.Form

Try to get a form value

getPossibleForm(String) - Method in class org.webmacro.servlet.WebContext

Try to get the value of a form variable from the request

getProperty(Object) - Method in class org.webmacro.Context

Same as get(name) but can be overridden by subclasses to do something different

getProperty(Object[]) - Method in class org.webmacro.Context

Same as get(Object names[]) but can be overridden by subclasses to behave differently

getProperty(Context, Object, Object[], int) - Method in class org.webmacro.engine.PropertyOperatorCache

Attempt to retrieve a property using the rules of property introspection described above.

getProperty(Context, Object, Object[]) - Method in class org.webmacro.engine.PropertyOperatorCache

Calls getProperty(context, instance, names, 0)

getPropertyNames() - Method in class org.webmacro.engine.Variable

getProvider(String) - Method in class org.webmacro.Broker

Get a provider

getProviderTypes() - Method in class org.webmacro.Broker

Get an Iterator of String names that the Provider items in this Broker have been registered under.

getQUERY_STRING() - Method in class org.webmacro.servlet.CGI_Impersonator

In a GET request, return the query string that was submitted, if any

getREMOTE_ADDR() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the remove address connected to this servlet

getREMOTE_HOST() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the remote host connected to this request

getREMOTE_USER() - Method in class org.webmacro.servlet.CGI_Impersonator

Name of the remote user if it was supplied with the HTTP request

getREQUEST_METHOD() - Method in class org.webmacro.servlet.CGI_Impersonator

Return what type of REQUEST this was: GET, POST, etc.

getReader() - Method in class org.webmacro.engine.FileTemplate

Get the stream the template should be read from.

getReader() - Method in class org.webmacro.engine.StreamTemplate

Get the stream the template should be read from.

getReader() - Method in class org.webmacro.engine.StringTemplate

Get the stream the template should be read from.

getReader() - Method in class org.webmacro.engine.WMTemplate

Get the stream the template should be read from.

getReader() - Method in class org.webmacro.resource.URLTemplate

Get the stream the template should be read from.

getRepeatingSubdirective(int) - Method in class org.webmacro.directive.DirectiveBuilder

Retrieves an array of ArgsHolders for the associated subdirective so that the subdirective arguments can be retrieved.

getRequest() - Method in class org.webmacro.adapter.jsp.JSPAttributes

getRequest() - Method in class org.webmacro.servlet.WebContext

The HttpServletRequest object which contains information provided by the HttpServlet superclass about the Request.

getRequestURL() - Method in class org.webmacro.servlet.URLTool.URLToolImpl

Get the url thas was used to access this page, as it is returned by HttpUtils.getRequestURL.

getResource(String) - Method in class org.webmacro.Broker

Get a resource (file) from the the Broker's class loader.

getResource(String) - Method in class org.webmacro.servlet.Servlet20Broker

Get a resource (file) from the the Broker's class loader

getResource(String) - Method in class org.webmacro.servlet.Servlet22Broker

Get a resource (file) from the the Broker's class loader

getResourceAsStream(String) - Method in class org.webmacro.Broker

Get a resource (file) from the Broker's class loader

getResourceAsStream(String) - Method in class org.webmacro.servlet.Servlet20Broker

Get a resource (file) from the Broker's class loader

getResourceAsStream(String) - Method in class org.webmacro.servlet.Servlet22Broker

Get a resource (file) from the Broker's class loader

getResponse() - Method in class org.webmacro.servlet.WebContext

The HttpServletResponse object which contains information about the response we are going to send back.

getRootCause() - Method in class org.webmacro.RethrowableException

Return the original exception cause.

getRootCause() - Method in class org.webmacro.RethrowableRuntimeException

Return the original exception cause.

getRootContext() - Method in class org.webmacro.engine.MacroBuildContext

getSCRIPT_NAME() - Method in class org.webmacro.servlet.CGI_Impersonator

What portion of the URL represents the servlet being run.

getSERVER_NAME() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the name of the server

getSERVER_PORT() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the server port

getSERVER_PROTOCOL() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the server protocol

getSERVER_SOFTWARE() - Method in class org.webmacro.servlet.CGI_Impersonator

Return the server info

getSelected() - Method in class org.webmacro.util.SelectList

getServletContext() - Method in class org.webmacro.servlet.ServletBroker

getSession() - Method in class org.webmacro.adapter.jsp.JSPAttributes

getSession() - Method in class org.webmacro.servlet.WebContext

get the session object

getSetting(String) - Method in class org.webmacro.Broker

Access to the settings in WebMacro.properties

getSetting(String) - Method in class org.webmacro.util.Settings

Get a setting.

getSetting(String, String) - Method in class org.webmacro.util.Settings

Get a setting with a default value in case it is not set

getSetting(String) - Method in class org.webmacro.util.SubSettings

Get a setting

getSettings() - Method in class org.webmacro.Broker

Access to the settings in WebMacro.properties

getSettings() - Method in class org.webmacro.util.WMEval

Return the settings associated with this WebMacro instance.

getSrc() - Method in class org.webmacro.adapter.jsp.TemplateTag

Get the src of an external template to use

getSubdirective(int) - Method in class org.webmacro.directive.DirectiveBuilder

Retrieves the ArgsHolder for the associated subdirective so that the subdirective arguments can be retrieved.

getSubdirectiveCount(int) - Method in class org.webmacro.directive.DirectiveBuilder

Find out how many subdirectives of the specified id were present.

getSystemLog(String) - Static method in class org.webmacro.util.LogSystem

Get a system-wide log

getSystemLog(String, String) - Static method in class org.webmacro.util.LogSystem

Get a system log, providing it with a description of itself

getTemplate(String) - Method in class org.webmacro.Broker

Get a template from the Broker.

getTemplate(String) - Method in class org.webmacro.WM

Retrieve a template from the "template" provider.

getTemplate(String) - Method in interface org.webmacro.WebMacro

Retrieve a template from the "template" provider.

getTemplate(Broker, String) - Method in class org.webmacro.directive.IncludeDirective

get a Template via the "template" provider known by the specified broker

getTemplate(String) - Method in class org.webmacro.servlet.Servlet22Broker

Get a template; kind of like getting a resource, but might come from a different place

getTemplate(String) - Method in class org.webmacro.servlet.WMServlet

Retrieve a template from the "template" provider.

getTemplate() - Static method in class org.webmacro.util.SparseProperties

getTemplate(Properties) - Static method in class org.webmacro.util.SparseProperties

getTemplateEvaluationContext() - Method in class org.webmacro.Context

getTemplateExtensions(Broker) - Method in class org.webmacro.directive.IncludeDirective

get an array of Template file extensions we should use, if type==dynamic, to decide if the specified file is a template or not

getTemplateLoader(Broker, String) - Method in class org.webmacro.resource.DefaultTemplateLoaderFactory

getTemplateLoader(Broker, String) - Method in interface org.webmacro.resource.TemplateLoaderFactory

Create a template loader

getTemplateLoaders() - Method in class org.webmacro.resource.DelegatingTemplateProvider

Returns an unmodifieable list of this provider's template loaders.

getTemplateName() - Method in class org.webmacro.engine.Block

getThingToInclude(Broker, int, String) - Method in class org.webmacro.directive.IncludeDirective

get the template or file that the user wants to include, based on the specified type.

getToken(int) - Method in class org.webmacro.parser.WMParser_impl

getType() - Method in interface org.webmacro.Provider

Return an array representing the types this provider serves up

getType() - Method in class org.webmacro.directive.DirectiveProvider

getType() - Method in class org.webmacro.engine.ParserProvider

getType() - Method in class org.webmacro.resource.BrokerTemplateProvider

getType() - Method in class org.webmacro.resource.ConfigProvider

getType() - Method in class org.webmacro.resource.DelegatingTemplateProvider

getType() - Method in class org.webmacro.resource.TemplateProvider

Supports the "template" type

getType() - Method in class org.webmacro.resource.URLTemplateProvider

Supports the "template" type.

getType() - Method in class org.webmacro.resource.UrlProvider

We serve up "url" type resources

getType() - Method in class org.webmacro.util.EncoderProvider

Return an array representing the types this provider serves up

getType() - Method in class org.webmacro.util.LogSource

The type of this log source, as it would print in the log.

getURL(String) - Method in class org.webmacro.WM

Retrieve a URL from the "url" provider.

getURL(String) - Method in interface org.webmacro.WebMacro

Retrieve the contents of a URL as a String.

getURL() - Method in class org.webmacro.resource.URLTemplate

return the URL for the current template.

getURL(String) - Method in class org.webmacro.servlet.WMServlet

Retrieve a URL.

getUrlInputStream(URL) - Static method in class org.webmacro.resource.UrlProvider

Utility routine to get the input stream associated with a URL.

getUrlLastModified(URL) - Static method in class org.webmacro.resource.UrlProvider

Utility routine to get the last modification date for a URL.

getValue(String, String) - Method in class org.webmacro.Broker

Deprecated. call get(String,String) instead

getValue() - Method in class org.webmacro.engine.Argument

Return the object on which this predicate operates

getValue(Context) - Method in class org.webmacro.engine.ConstantPropertyVariable

Look up my value in the corresponding Map, possibly using introspection, and return it

getValue(Context) - Method in class org.webmacro.engine.FunctionVariable

The code to get the value represented by the variable from the supplied context.

getValue(Context) - Method in class org.webmacro.engine.MacroPropertyVariable

Look up my value in the corresponding Map, possibly using introspection, and return it

getValue(Context) - Method in class org.webmacro.engine.Variable

The code to get the value represented by the variable from the supplied context.

getValue() - Method in class org.webmacro.util.SelectList

getVariableName() - Method in class org.webmacro.engine.Variable

Return the canonical name for this variable

getVariableType(String) - Method in class org.webmacro.engine.BuildContext

Find out whether the named variable is a tool, local variable, or property variable.

getWarningText(String, Context) - Static method in class org.webmacro.directive.Directive

Convenience method for directives to write HTML warnings into the output stream.

getWebContext(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.WM

Instantiate a new webcontext.

getWebContext(HttpServletRequest, HttpServletResponse) - Method in interface org.webmacro.WebMacro

Create a new WebContext object.

getWebContext(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.WMServlet

Create a new WebContext object; can be overridden

getWebMacro() - Method in class org.webmacro.adapter.jsp.TemplateTag

Get or create our WebMacro instance

getWebMacro() - Method in class org.webmacro.adapter.spring.WebMacroView

getWebMacro() - Method in class org.webmacro.adapter.spring.WebMacroViewResolver

globalContext - Variable in class org.webmacro.servlet.TemplateServlet

The global context.

globalDefault - Variable in class org.webmacro.util.SparseProperties

The global default value for all requests is ""

globalName - Variable in class org.webmacro.servlet.TemplateServlet

The global context name to place in the context.

globalTemplate - Variable in class org.webmacro.servlet.TemplateServlet

The global template.

guessType(Broker, String) - Method in class org.webmacro.directive.IncludeDirective

if the filename contains :// assume it's a file b/c it's probably a url.

H

HTMLEncode(String) - Static method in class org.webmacro.servlet.TextTool

HTMLEncode will encode the specified input String per the magic of org.webmacro.util.HTMLEscaper.

HTMLEscaper - class org.webmacro.util.HTMLEscaper.

This class will escape characters that have an HTML entity representation.

HTMLEscaper() - Constructor for class org.webmacro.util.HTMLEscaper

Handler - interface org.webmacro.servlet.Handler.

Framework for handling template requests, requested by reactor.

HandlerException - exception org.webmacro.servlet.HandlerException.

This is an exception which a Handler can throw to indicate that it does not want to process a connection request.

HandlerException(String) - Constructor for class org.webmacro.servlet.HandlerException

Declare a handler exception with a reason

HandlerException(String, Exception) - Constructor for class org.webmacro.servlet.HandlerException

handle(WebContext) - Method in class org.webmacro.servlet.WMServlet

This method is called to handle the processing of a request.

handleWebRequest(HttpServlet, WebContext, String) - Method in interface org.webmacro.servlet.ServletRouter

Implement this interface to process a request intercepted by the TemplateServlet.

hasBreakingSubdirectives - Variable in class org.webmacro.directive.DirectiveDescriptor

hasMoreElements() - Method in class org.webmacro.util.SelectList

hasNext() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

hasNext() - Method in class org.webmacro.util.ArrayIterator

Return true if we have not yet reached the end of the enumeration

hasNext() - Method in class org.webmacro.util.EnumIterator

Return true if we have not yet reached the end of the enumeration

hasNext() - Method in class org.webmacro.util.PrimitiveArrayIterator

Return true if we have not yet reached the end of the enumeration

hasTargets() - Method in class org.webmacro.util.LogSource

hashCode() - Method in class org.webmacro.servlet.ServletBroker.PropertiesPair

hashCode() - Method in class org.webmacro.util.Encoder.Block

helper - Variable in class org.webmacro.resource.AbstractTemplateLoader

Helper class for loading templates from files or URLs

I

INFO - Static variable in class org.webmacro.util.LogSystem

INTEGER - Static variable in class org.webmacro.util.CastUtil

IncludeDirective - class org.webmacro.directive.IncludeDirective.

IncludeDirective allows you to include other text files or Templates into the current Template.

IncludeDirective() - Constructor for class org.webmacro.directive.IncludeDirective

InitException - exception org.webmacro.InitException.

This exception is used to indicate that a somethin was not propertly able to initialize itself.

InitException(String) - Constructor for class org.webmacro.InitException

InitException(String, Throwable) - Constructor for class org.webmacro.InitException

Instantiator - class org.webmacro.util.Instantiator.

Utility class for loading and instantiating classes subject to package restrictions specified by the AllowedPackages property, and using implicit package names specified by the ImpliedPackages configuration property.

IntrospectionException - exception org.webmacro.engine.IntrospectionException.

IntrospectionException(String, Exception) - Constructor for class org.webmacro.engine.IntrospectionException

IntrospectionException(String) - Constructor for class org.webmacro.engine.IntrospectionException

IntrospectionUtils - class org.webmacro.engine.IntrospectionUtils.

InvalidArgumentException - exception org.webmacro.util.InvalidArgumentException.

One of the arguments supplied had an invalid value.

InvalidArgumentException(String) - Constructor for class org.webmacro.util.InvalidArgumentException

InvalidContextException - exception org.webmacro.InvalidContextException.

The context supplied to a macro did not contain information that the macro required in order to write or evaluate itself.

InvalidContextException(String) - Constructor for class org.webmacro.InvalidContextException

InvalidResourceException - exception org.webmacro.resource.InvalidResourceException.

Resource exists but could not be loaded for some reason

InvalidResourceException(String, Exception) - Constructor for class org.webmacro.resource.InvalidResourceException

InvalidResourceException(String) - Constructor for class org.webmacro.resource.InvalidResourceException

InvalidTypeException - exception org.webmacro.InvalidTypeException.

You used a class or argument that was incorrect, unknown, or otherwise invalid.

InvalidTypeException(String) - Constructor for class org.webmacro.InvalidTypeException

id - Variable in class org.webmacro.directive.Directive.ArgDescriptor

image - Variable in class org.webmacro.parser.Token

The string image of the token.

info(String) - Method in interface org.webmacro.Log

Info is fairly unimportant information about routine processing within the system.

info(String) - Method in class org.webmacro.util.LogSource

Info is fairly unimportant information about routine processing within the system.

init() - Method in class org.webmacro.Broker

Constructors should call this after they've set up the properties to set up common things like profiling, providers, etc.

init(Context) - Method in class org.webmacro.ContextTool

A new tool object will be instantiated per-request by calling this method.

init(Broker, Settings) - Method in interface org.webmacro.Provider

Initialize this provider based on the specified config.

init(Broker, String) - Method in interface org.webmacro.broker.ContextAutoLoader

Called once after construction.

init(Broker, String) - Method in class org.webmacro.broker.DefaultContextAutoLoader

init(Broker) - Static method in class org.webmacro.directive.BeanDirective

init(Broker, Settings) - Method in class org.webmacro.directive.DirectiveProvider

init(Broker, Settings) - Method in class org.webmacro.engine.CrankyEvaluationExceptionHandler

init(Broker, Settings) - Method in class org.webmacro.engine.DebugEvaluationExceptionHandler

init(Broker, Settings) - Method in class org.webmacro.engine.DefaultEvaluationExceptionHandler

init(Broker, Settings) - Method in interface org.webmacro.engine.EvaluationExceptionHandler

Initialize the EEH

init(Broker, Settings) - Method in class org.webmacro.engine.ParserProvider

init(Broker, Settings) - Method in class org.webmacro.engine.PropertyOperatorCache

init(Broker, Settings) - Method in class org.webmacro.resource.AbstractTemplateLoader

Sets up broker, reloadDelayDecorator and log.

init(Broker, Settings) - Method in class org.webmacro.resource.BrokerTemplateProvider

init(Broker, Settings) - Method in class org.webmacro.resource.BrokerTemplateProviderHelper

Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return

init(Broker, Settings, String) - Method in interface org.webmacro.resource.CacheManager

Same as defined in Provider, except with an additional type parameter so it knows what type of resource it is caching

init(Broker, Settings) - Method in class org.webmacro.resource.CachingProvider

If you override this method be sure and call super.init(...)

init(Broker, Settings) - Method in class org.webmacro.resource.ClassPathTemplateLoader

init(Broker, Settings) - Method in class org.webmacro.resource.ConfigProvider

init(Broker, Settings) - Method in class org.webmacro.resource.DelegatingTemplateProvider

init(Broker, Settings) - Method in class org.webmacro.resource.ReloadDelayDecorator

Initialize object.

init(Broker, Settings, String) - Method in class org.webmacro.resource.ReloadingCacheManager

init(Broker, Settings) - Method in interface org.webmacro.resource.ResourceLoader

Initialize this provider based on the specified config.

init(Broker, Settings) - Method in class org.webmacro.resource.ServletContextTemplateLoader

init(Broker, Settings, String) - Method in class org.webmacro.resource.SimpleCacheManager

init(Broker, Settings) - Method in interface org.webmacro.resource.TemplateLoader

Init this template loader*

init(Broker, Settings) - Method in class org.webmacro.resource.TemplateLoaderHelper

Initialize this object

init(Broker, Settings) - Method in class org.webmacro.resource.TemplateProvider

Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return

init(Broker, Settings, String) - Method in class org.webmacro.resource.TrivialCacheManager

init(Broker, Settings) - Method in class org.webmacro.resource.URLTemplateProvider

Create a new TemplateProvider that uses the specified directory as the source for Template objects that it will return

init(Broker, Settings) - Method in class org.webmacro.resource.UrlProvider

init(Context) - Method in class org.webmacro.servlet.CGITool

init(Context) - Method in class org.webmacro.servlet.CookieTool

init(Context) - Method in class org.webmacro.servlet.FormListTool

init(Context) - Method in class org.webmacro.servlet.FormTool

init() - Method in interface org.webmacro.servlet.Handler

Use this method to run any startup initialization that you need to perform.

init(Context) - Method in class org.webmacro.servlet.ListTool

init(Context) - Method in class org.webmacro.servlet.LocaleTool

init(Context) - Method in class org.webmacro.servlet.MathTool

Tool initialization method.

init(Context) - Method in class org.webmacro.servlet.RequestTool

init(Context) - Method in class org.webmacro.servlet.ResponseTool

init() - Method in class org.webmacro.servlet.Servlet22Broker

init(Context) - Method in class org.webmacro.servlet.SessionTool

init(ServletConfig) - Method in class org.webmacro.servlet.TemplateServlet

Looks for a global template to evaluate (defined in WebMacro.properties).

init(Context) - Method in class org.webmacro.servlet.TemplateTool

Create a factory object that can be accessed from WMScript as $Template for creating MacroTemplate objects.

init(Context) - Method in class org.webmacro.servlet.TextTool

Tool initialization method.

init(Context) - Method in class org.webmacro.servlet.TypeTool

init(Context) - Method in class org.webmacro.servlet.URLTool

init(Context) - Method in class org.webmacro.servlet.VariableTool

init(ServletConfig) - Method in class org.webmacro.servlet.WMServlet

This is the old-style init method, it just calls init(), after handing the ServletConfig object to the superclass

init() - Method in class org.webmacro.servlet.WMServlet

This method is called by the servlet runner--do not call it.

init(Broker, Settings) - Method in class org.webmacro.util.Encoder

init(Broker, Settings) - Method in class org.webmacro.util.EncoderProvider

Initialize this provider based on the specified config.

init(InputStream) - Method in class org.webmacro.util.WMEval

Initializes WMEval so that it can perform currentTemplate evaluation on multiple contexts.

initLog() - Method in class org.webmacro.Broker

Constructors should call this after they've set up the properties to set up the log target.

initLog(Settings) - Method in class org.webmacro.servlet.ServletBroker

initWebContext() - Method in class org.webmacro.servlet.WMServlet

Deprecated.

initWebMacro() - Method in class org.webmacro.servlet.WMServlet

This method returns the WebMacro object which will be used to load, access, and manage the Broker.

input_stream - Variable in class org.webmacro.parser.WMParser_implTokenManager

instance - Static variable in class org.webmacro.engine.VoidMacro

instantiate(Class, Object[]) - Static method in class org.webmacro.engine.IntrospectionUtils

attempt to instantiate a class with the supplied args

instantiate(Class, Object[]) - Method in class org.webmacro.util.Instantiator

internalGet(Object) - Method in class org.webmacro.Context

Get the named object/property from the Context.

internalGet(Object[]) - Method in class org.webmacro.Context

Get the named object from the Context.

internalGet(Object) - Method in class org.webmacro.engine.MacroBuildContext

invalidate(Object) - Method in interface org.webmacro.resource.CacheManager

Invalidates an entry in the cache.

invalidate(Object) - Method in class org.webmacro.resource.ReloadingCacheManager

Removes a specific entry from the cache.

invalidate(Object) - Method in class org.webmacro.resource.SimpleCacheManager

Remove an element

invalidate(Object) - Method in class org.webmacro.resource.TrivialCacheManager

invoke(Object[]) - Method in class org.webmacro.engine.MethodWrapper

isArray(Object) - Method in class org.webmacro.servlet.ListUtil

isBreaking - Variable in class org.webmacro.directive.Directive.Subdirective

isDefined(Object) - Method in class org.webmacro.servlet.VariableTool

Is the specified object name defined in the active Context?

isEmpty() - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

isEmpty(Object) - Static method in class org.webmacro.servlet.ListUtil

isEmpty() - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

isEven() - Method in class org.webmacro.engine.TestObject

isFailFast() - Method in class org.webmacro.adapter.jsp.TemplateTag

isInstanceOf(Object, String) - Method in class org.webmacro.servlet.VariableTool

Is the specified object, obj, an instance of the specified className?

isList(Object) - Method in class org.webmacro.servlet.ListUtil

isNumber(Object) - Static method in class org.webmacro.engine.Expression

isSelected() - Method in class org.webmacro.util.SelectList

isSimpleName() - Method in class org.webmacro.engine.FunctionVariable

isSimpleName() - Method in class org.webmacro.engine.Variable

Returns true if the Variable describes a simple name (one with only one element)

isTrue(Object) - Static method in class org.webmacro.engine.Expression

J

JSPAttributes - class org.webmacro.adapter.jsp.JSPAttributes.

Class that provides access to the JSP pageContext attributes with scoping, such that $Attributes.SCOPE.xxxx returns appropriate values.

JSPAttributes(PageContext) - Constructor for class org.webmacro.adapter.jsp.JSPAttributes

JSPAttributes.ApplicationAttributes - class org.webmacro.adapter.jsp.JSPAttributes.ApplicationAttributes.

JSPAttributes.ApplicationAttributes() - Constructor for class org.webmacro.adapter.jsp.JSPAttributes.ApplicationAttributes

JSPAttributes.PageAttributes - class org.webmacro.adapter.jsp.JSPAttributes.PageAttributes.

JSPAttributes.PageAttributes() - Constructor for class org.webmacro.adapter.jsp.JSPAttributes.PageAttributes

JSPAttributes.RequestAttributes - class org.webmacro.adapter.jsp.JSPAttributes.RequestAttributes.

JSPAttributes.RequestAttributes() - Constructor for class org.webmacro.adapter.jsp.JSPAttributes.RequestAttributes

JSPAttributes.SessionAttributes - class org.webmacro.adapter.jsp.JSPAttributes.SessionAttributes.

JSPAttributes.SessionAttributes() - Constructor for class org.webmacro.adapter.jsp.JSPAttributes.SessionAttributes

jjFillToken() - Method in class org.webmacro.parser.WMParser_implTokenManager

jj_nt - Variable in class org.webmacro.parser.WMParser_impl

jjnewLexState - Static variable in class org.webmacro.parser.WMParser_implTokenManager

jjstrLiteralImages - Static variable in class org.webmacro.parser.WMParser_implTokenManager

join(String[], String) - Static method in class org.webmacro.servlet.TextTool

Join the input String[] into a single String, using the specified delimiter between each value of the array.

K

Keyword(String) - Method in class org.webmacro.parser.WMParser_impl

keySet() - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

keyString() - Method in class org.webmacro.util.DictionaryTool

Return a string which concatenates the keys, putting commas between the keys

keys() - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

keyword - Variable in class org.webmacro.directive.Directive.ArgDescriptor

kind - Variable in class org.webmacro.parser.Token

An integer that describes the kind of this token.

L

LBRACE - Static variable in interface org.webmacro.parser.WMParser_implConstants

LBRACKET - Static variable in interface org.webmacro.parser.WMParser_implConstants

LEVELS - Static variable in class org.webmacro.util.LogSystem

Mapping of numbers to names.

LOCAL_TYPE - Static variable in class org.webmacro.engine.Variable

LONG - Static variable in class org.webmacro.util.CastUtil

LPAREN - Static variable in interface org.webmacro.parser.WMParser_implConstants

LValue() - Method in class org.webmacro.parser.WMParser_impl

LexicalError(boolean, int, int, int, String, char) - Static method in class org.webmacro.parser.TokenMgrError

Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error.

ListBuilder - class org.webmacro.engine.ListBuilder.

ListBuilder is used for building argument lists to function calls or array initializers.

ListBuilder() - Constructor for class org.webmacro.engine.ListBuilder

ListTool - class org.webmacro.servlet.ListTool.

Provide templates a uniform way of dealing with arrays and Lists

ListTool() - Constructor for class org.webmacro.servlet.ListTool

ListUtil - class org.webmacro.servlet.ListUtil.

A utility class for templates loaded into the context as "List" by ListTool.

LiteralBlock() - Method in class org.webmacro.parser.WMParser_impl

LiteralWMContent(ParserBlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

LocaleTool - class org.webmacro.servlet.LocaleTool.

Provide Template with access to Locales.

LocaleTool() - Constructor for class org.webmacro.servlet.LocaleTool

Log - interface org.webmacro.Log.

A log is a simple recipient of information about the system.

LogFile - class org.webmacro.util.LogFile.

Provides a concrete implementation the AbstractLogFile.

LogFile(Settings) - Constructor for class org.webmacro.util.LogFile

Create a new LogFile instance.

LogFile(String) - Constructor for class org.webmacro.util.LogFile

LogFile(PrintStream) - Constructor for class org.webmacro.util.LogFile

Create a new LogFile instance

LogSource - class org.webmacro.util.LogSource.

A log is a simple recipient of information about the system.

LogSystem - class org.webmacro.util.LogSystem.

The LogSystem class allows you to create and manage log objects and log targets.

LogSystem(String) - Constructor for class org.webmacro.util.LogSystem

LogTarget - interface org.webmacro.util.LogTarget.

A log target is a destination for log messages.

LogTargetFactory - class org.webmacro.util.LogTargetFactory.

The LogTargetFactory assists the Broker (and you, if you want) in creating new LogTarget instances.

LogTargetFactory.LogCreationException - exception org.webmacro.util.LogTargetFactory.LogCreationException.

LogTargetFactory.LogCreationException(String, Throwable) - Constructor for class org.webmacro.util.LogTargetFactory.LogCreationException

lexStateNames - Static variable in class org.webmacro.parser.WMParser_implTokenManager

load(String, CacheElement) - Method in class org.webmacro.URLTemplateLoader

Tries to load a template by interpreting query as a path relative to the path set by setPath.

load(String, CacheElement) - Method in class org.webmacro.resource.BrokerTemplateLoader

load(String, CacheElement) - Method in class org.webmacro.resource.BrokerTemplateProvider

load(String, CacheElement) - Method in class org.webmacro.resource.BrokerTemplateProviderHelper

Grab a template based on its name.

load(Object, CacheElement) - Method in class org.webmacro.resource.BrokerTemplateProviderHelper

We don't implement this one

load(Object, CacheElement) - Method in class org.webmacro.resource.CachingProvider

load(String, CacheElement) - Method in class org.webmacro.resource.ClassPathTemplateLoader

load(String, CacheElement) - Method in class org.webmacro.resource.DelegatingTemplateProvider

Ask all template loaders to load a template from query.

load(String, CacheElement) - Method in class org.webmacro.resource.FileTemplateLoader

Tries to load a template by interpreting query as a path relative to the path set by setPath.

load(String, CacheElement) - Method in interface org.webmacro.resource.ResourceLoader

Load an object from permanent storage (or construct it) on demand.

load(Object, CacheElement) - Method in interface org.webmacro.resource.ResourceLoader

Load an object from permanent storage (or construct it) on demand.

load(String, CacheElement) - Method in class org.webmacro.resource.ServletContextTemplateLoader

load(String, CacheElement) - Method in interface org.webmacro.resource.TemplateLoader

Try to load a template.

load(File, CacheElement) - Method in class org.webmacro.resource.TemplateLoaderHelper

Load a template from a file.

load(URL, CacheElement) - Method in class org.webmacro.resource.TemplateLoaderHelper

Load a template from an url.

load(String, CacheElement) - Method in class org.webmacro.resource.TemplatePathTemplateLoader

load(String, CacheElement) - Method in class org.webmacro.resource.TemplateProvider

Grab a template based on its name.

load(String, CacheElement) - Method in class org.webmacro.resource.URLTemplateProvider

Grab a template based on its name, setting the request event to contain it if we found it.

load(String, URL) - Method in class org.webmacro.resource.URLTemplateProvider

Find the specified template in the directory managed by this template store.

load(String, CacheElement) - Method in class org.webmacro.resource.UrlProvider

Load a URL from the specified name and return it.

load(Object, CacheElement) - Method in class org.webmacro.util.Encoder

Load an object from permanent storage (or construct it) on demand.

load(String, CacheElement) - Method in class org.webmacro.util.Encoder

load(String) - Method in class org.webmacro.util.Settings

Load settings from the supplied fileName, searching for the file along the classpath, and then search for the settings file as a file: URL.

load(URL) - Method in class org.webmacro.util.Settings

Load settings from the supplied URL

load(InputStream) - Method in class org.webmacro.util.Settings

Load settings from the supplied input stream

load(Settings) - Method in class org.webmacro.util.Settings

Load settings from a Settings

load(Properties, String) - Method in class org.webmacro.util.Settings

Load settings from a Properties, only extracting properties which have the specified prefix

load(Properties) - Method in class org.webmacro.util.Settings

Load settings from a Properties

loadDefaultSettings() - Method in class org.webmacro.Broker

loadDelegationContext(WebContext, String, HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.TemplateServlet

Implementation for populating the context by a runtime defined delegate.

loadRequestContext(WebContext, String, HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.TemplateServlet

Implementation for populating the context: handles a default per request context.

loadServletSettings(String) - Method in class org.webmacro.servlet.Servlet22Broker

loadSettings(String, boolean) - Method in class org.webmacro.Broker

loadSettings(Properties) - Method in class org.webmacro.Broker

loadSystemSettings() - Method in class org.webmacro.Broker

locateTemplate(HttpServletRequest) - Method in class org.webmacro.servlet.TemplateServlet

Default implenentation for locating the template.

log - Variable in class org.webmacro.resource.AbstractTemplateLoader

Log to use

log(Date, String, String, String, Throwable) - Method in class org.webmacro.servlet.ServletLog

log - Variable in class org.webmacro.servlet.TemplateServlet

log(Date, String, String, String, Throwable) - Method in class org.webmacro.util.CommonsLoggingTarget

log(Date, String, String, String, Throwable) - Method in class org.webmacro.util.LogFile

log(int, String, Throwable) - Method in class org.webmacro.util.LogSource

log(Date, String, String, String, Throwable) - Method in interface org.webmacro.util.LogTarget

Log out an event that just happened and which you have previously accepted.

loggingDebug() - Method in interface org.webmacro.Log

Ask the log system if it wants these kinds of log messages.

loggingDebug() - Method in class org.webmacro.util.LogSource

loggingInfo() - Method in interface org.webmacro.Log

loggingInfo() - Method in class org.webmacro.util.LogSource

loggingNotice() - Method in interface org.webmacro.Log

loggingNotice() - Method in class org.webmacro.util.LogSource

loggingWarning() - Method in interface org.webmacro.Log

loggingWarning() - Method in class org.webmacro.util.LogSource

lookingAhead - Variable in class org.webmacro.parser.WMParser_impl

ltrim(String) - Static method in class org.webmacro.servlet.TextTool

remove any leading whitespace from a string

ltrimBlock(String) - Static method in class org.webmacro.servlet.TextTool

remove the leading whitespace from each line in a block of text

M

MAX_TIMEOUT - Static variable in class org.webmacro.resource.UrlProvider

MIN_TIMEOUT - Static variable in class org.webmacro.resource.UrlProvider

Macro - interface org.webmacro.Macro.

Directives, variables, macro calls, blocks, conditions, text, etc., all have this as their supertype.

MacroAdapter - class org.webmacro.engine.MacroAdapter.

Looks like a Macro, but really it's not.

MacroArgList() - Method in class org.webmacro.parser.WMParser_impl

MacroBuildContext - class org.webmacro.engine.MacroBuildContext.

A chained build context, for use in expanding macros.

MacroBuildContext(MacroDefinition, Object[], BuildContext) - Constructor for class org.webmacro.engine.MacroBuildContext

MacroBuilder - class org.webmacro.engine.MacroBuilder.

MacroBuilder.java Represents the invocation of a (C-style) macro, which gets expanded during the building of a template.

MacroBuilder(String, ListBuilder, int, int) - Constructor for class org.webmacro.engine.MacroBuilder

MacroDefinition - class org.webmacro.engine.MacroDefinition.

MacroDefinition.java Represents a (C-style) macro, which gets expanded during the building of a template.

MacroDefinition(String, String[], Object) - Constructor for class org.webmacro.engine.MacroDefinition

MacroDirective - class org.webmacro.directive.MacroDirective.

MacroDirective

MacroDirective() - Constructor for class org.webmacro.directive.MacroDirective

MacroPropertyVariable - class org.webmacro.engine.MacroPropertyVariable.

Operate on bean properties of an existing macro; used when a Macro is passed as an argument to a macro

MapArgList() - Method in class org.webmacro.parser.WMParser_impl

MapBuilder - class org.webmacro.engine.MapBuilder.

MapBuilder is used during the parsing/building phase of a template to create user defined Map types, using a syntax that is similar to:

MapBuilder() - Constructor for class org.webmacro.engine.MapBuilder

MathTool - class org.webmacro.servlet.MathTool.

A ContextTool for performing the more useful methods from java.lang.Math.

MathTool() - Constructor for class org.webmacro.servlet.MathTool

default contsructor.

MathTool(Context) - Constructor for class org.webmacro.servlet.MathTool

public constructor.

MethodWrapper - class org.webmacro.engine.MethodWrapper.

MethodWrapper(Object, String) - Constructor for class org.webmacro.engine.MethodWrapper

Creates a new instance of MethodWrapperMacro

main(String[]) - Static method in class org.webmacro.Broker

Test the broker or a provider.

main(String[]) - Static method in class org.webmacro.WM

Print the version, and quit

main(String[]) - Static method in class org.webmacro.engine.StreamTemplate

Simple test

main(String[]) - Static method in class org.webmacro.engine.TemplateDumper

main(String[]) - Static method in class org.webmacro.engine.TestObject

main(String[]) - Static method in class org.webmacro.parser.WMParser_impl

main(String[]) - Static method in class org.webmacro.servlet.ListUtil

test harness

main(String[]) - Static method in class org.webmacro.servlet.MathTool

main(String[]) - Static method in class org.webmacro.servlet.TextTool

main(String[]) - Static method in class org.webmacro.tools.CheckTemplates

main(String[]) - Static method in class org.webmacro.tools.EvalTemplates

Normally this main is invoked from an ant task but it can be invoked from any main launcher including a command line.

main(String[]) - Static method in class org.webmacro.util.ArrayIterator

Test harness

main(String[]) - Static method in class org.webmacro.util.Base64

Test harness

main(String[]) - Static method in class org.webmacro.util.ByteBufferOutputStream

main(String[]) - Static method in class org.webmacro.util.CastUtil

main(String[]) - Static method in class org.webmacro.util.DictionaryTool

main(String[]) - Static method in class org.webmacro.util.EncodingCache

main(String[]) - Static method in class org.webmacro.util.EnumIterator

Test harness

main(String[]) - Static method in class org.webmacro.util.LogSystem

Test out the logging system

main(String[]) - Static method in class org.webmacro.util.PrimitiveArrayIterator

Test harness

main(String[]) - Static method in class org.webmacro.util.Settings

Brief test

makeBlock(String[]) - Static method in class org.webmacro.servlet.TextTool

convert an array of strings into a block of text delimited by \r\n

markLiteral() - Method in class org.webmacro.parser.ParserBlockBuilder

Mark the last character in the block as being a literal (quoted with backslash) so we don't eat trailing quoted whitespace.

max(int, int) - Static method in class org.webmacro.servlet.MathTool

max(long, long) - Static method in class org.webmacro.servlet.MathTool

max(float, float) - Static method in class org.webmacro.servlet.MathTool

max(double, double) - Static method in class org.webmacro.servlet.MathTool

mergeConstants(Template) - Method in class org.webmacro.engine.BuildContext

Add #macros and #params from the specified Template to this bulid context

methodName - Variable in class org.webmacro.PropertyException.NoSuchMethodException

methodName - Variable in class org.webmacro.PropertyException.NoSuchMethodWithArgumentsException

min(int, int) - Static method in class org.webmacro.servlet.MathTool

min(long, long) - Static method in class org.webmacro.servlet.MathTool

min(float, float) - Static method in class org.webmacro.servlet.MathTool

min(double, double) - Static method in class org.webmacro.servlet.MathTool

mod(int, int) - Static method in class org.webmacro.servlet.MathTool

multiply(Number, Number) - Static method in class org.webmacro.servlet.MathTool

Converts args to doubles and multiplies them together.

N

NEWLINE - Static variable in interface org.webmacro.parser.WMParser_implConstants

NONE - Static variable in class org.webmacro.util.LogSystem

NOTICE - Static variable in class org.webmacro.util.LogSystem

NULL - Static variable in interface org.webmacro.parser.WMParser_implConstants

NUMBER - Static variable in interface org.webmacro.parser.WMParser_implConstants

Named - interface org.webmacro.util.Named.

A type that has a name.

NativeAsciiReader - class org.webmacro.util.NativeAsciiReader.

Reads a file that has been encoded with Java's unicode escape syntax, typically converted with native2ascii.

NativeAsciiReader(Reader, int) - Constructor for class org.webmacro.util.NativeAsciiReader

NativeAsciiReader(Reader) - Constructor for class org.webmacro.util.NativeAsciiReader

NotFoundException - exception org.webmacro.NotFoundException.

You asked for something that is not currently available.

NotFoundException(String, Exception) - Constructor for class org.webmacro.NotFoundException

NotFoundException(String) - Constructor for class org.webmacro.NotFoundException

NullBuilder - class org.webmacro.engine.NullBuilder.

NullBuilder() - Constructor for class org.webmacro.engine.NullBuilder

NullParser - class org.webmacro.engine.NullParser.

This parser eats all of the input and returns nothing.

NullParser(Broker) - Constructor for class org.webmacro.engine.NullParser

name - Variable in class org.webmacro.directive.Directive.Subdirective

name - Variable in class org.webmacro.directive.DirectiveDescriptor

newContext(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.WMServlet

This method is called at the beginning of a request and is responsible for providing a Context for the request.

newSubdirective(int) - Method in class org.webmacro.directive.DirectiveBuilder

Create a new subdirective of the specified id and create an ArgsHolder for its arguments.

newToken(int) - Static method in class org.webmacro.parser.Token

Returns a new Token object, by default.

newWebContext(HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.servlet.WMServlet

next() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

next - Variable in class org.webmacro.parser.Token

A reference to the next regular (non-special) token from the input stream.

next() - Method in class org.webmacro.util.ArrayIterator

Advance the iterator and return the next value.

next() - Method in class org.webmacro.util.EnumIterator

Advance the iterator and return the next value.

next() - Method in class org.webmacro.util.PrimitiveArrayIterator

Advance the iterator and return the next value.

nextArg - Variable in class org.webmacro.directive.Directive.ArgDescriptor

nextElement() - Method in class org.webmacro.util.SelectList

notice(String) - Method in interface org.webmacro.Log

Notices are important information about routine processing within the system.

notice(String) - Method in class org.webmacro.util.LogSource

Notices are important information about routine processing within the system.

numberObject(long, Object, Object) - Static method in class org.webmacro.engine.Expression

numberValue(Object) - Static method in class org.webmacro.engine.Expression

O

OP_AND - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_DIV - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_EQ - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_GE - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_GT - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_LE - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_LT - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_MINUS - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_MULT - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_NE - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_NOT - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_OR - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_PLUS - Static variable in interface org.webmacro.parser.WMParser_implConstants

OP_SET - Static variable in interface org.webmacro.parser.WMParser_implConstants

OTHER - Static variable in interface org.webmacro.parser.WMParser_implConstants

ObjectRoot() - Method in class org.webmacro.parser.WMParser_impl

OptionalWs() - Method in class org.webmacro.parser.WMParser_impl

OptionalWsNl() - Method in class org.webmacro.parser.WMParser_impl

OrExpression() - Method in class org.webmacro.parser.WMParser_impl

operate(Object, Object) - Method in class org.webmacro.engine.Expression.AddOperation

operate(Object, Object) - Method in class org.webmacro.engine.Expression.BinaryOperation

operate(Object, Object) - Method in class org.webmacro.engine.Expression.Compare

operate(Object, Object) - Method in class org.webmacro.engine.Expression.DivideOperation

operate(Object, Object) - Method in class org.webmacro.engine.Expression.MultiplyOperation

operate(Object) - Method in class org.webmacro.engine.Expression.NotOperation

operate(Object, Object) - Method in class org.webmacro.engine.Expression.SubtractOperation

operate(Object) - Method in class org.webmacro.engine.Expression.UnaryOperation

optional - Variable in class org.webmacro.directive.Directive.ArgDescriptor

org.webmacro - package org.webmacro

Primarily interfaces defining the core functionality of WebMacro.

org.webmacro.adapter.jsp - package org.webmacro.adapter.jsp

org.webmacro.adapter.spring - package org.webmacro.adapter.spring

org.webmacro.broker - package org.webmacro.broker

Interfaces for broker implementations.

org.webmacro.directive - package org.webmacro.directive

Classes which implement a WebMacro Directive.

org.webmacro.engine - package org.webmacro.engine

Classes that implement the core functionality of WebMacro.

org.webmacro.parser - package org.webmacro.parser

The WebMacro parser (jj) and supporting classes.

org.webmacro.resource - package org.webmacro.resource

Classes that relate to resources made available in the WebMacro system.

org.webmacro.servlet - package org.webmacro.servlet

Classes to support execution of WebMacro in a servlet container.

org.webmacro.tools - package org.webmacro.tools

Classes to support ant build and template evaluation automation.

org.webmacro.util - package org.webmacro.util

Classes to simplify evaluation, settings, logging, encoding/decoding and escaping.

outputContextKey - Static variable in class org.webmacro.util.WMEval

If an output file is not specified as an argument, it must be found in the context under this key.

P

PI - Static variable in class org.webmacro.servlet.MathTool

the value of PI, as defined by java.lang.Math.PI

POUND - Static variable in interface org.webmacro.parser.WMParser_implConstants

POUNDPOUND - Static variable in interface org.webmacro.parser.WMParser_implConstants

PROFILE - Static variable in class org.webmacro.Flags

Use in profiling statements in performance critical code?

PROPERTY_TYPE - Static variable in class org.webmacro.engine.Variable

ParamBuilder - class org.webmacro.engine.ParamBuilder.

ParamBuilder(Object[]) - Constructor for class org.webmacro.engine.ParamBuilder

ParamDirective - class org.webmacro.directive.ParamDirective.

The #param directive is provided for backward compatibility.

ParamDirective() - Constructor for class org.webmacro.directive.ParamDirective

ParseException - exception org.webmacro.engine.ParseException.

Exception raised on discovery of a parsing error.

ParseException() - Constructor for class org.webmacro.engine.ParseException

ParseException(String) - Constructor for class org.webmacro.engine.ParseException

Create a new exception

ParseException(String, Exception) - Constructor for class org.webmacro.engine.ParseException

Create a new exception, wrapping another exception

ParseException - exception org.webmacro.parser.ParseException.

This exception is thrown when parse errors are encountered.

ParseException(Token, int[][], String[]) - Constructor for class org.webmacro.parser.ParseException

This constructor is used by the method "generateParseException" in the generated parser.

ParseException() - Constructor for class org.webmacro.parser.ParseException

The following constructors are for use by you for whatever purpose you can think of.

ParseException(String) - Constructor for class org.webmacro.parser.ParseException

ParseException(String, Exception) - Constructor for class org.webmacro.parser.ParseException

Parser - interface org.webmacro.engine.Parser.

A parser turns an input stream into a BlockBuilder, using any parsing mechanism that it chooses.

ParserBlockBuilder - class org.webmacro.parser.ParserBlockBuilder.

ParserBlockBuilder extends BlockBuilder, and should only be used by the WMParser_impl parser.

ParserBlockBuilder() - Constructor for class org.webmacro.parser.ParserBlockBuilder

ParserBlockBuilder(String) - Constructor for class org.webmacro.parser.ParserBlockBuilder

ParserProvider - class org.webmacro.engine.ParserProvider.

Utility class to assist in the creation of directives.

ParserProvider() - Constructor for class org.webmacro.engine.ParserProvider

ParserRuntimeException - exception org.webmacro.parser.ParserRuntimeException.

Runtime exception for passing exceptions through the parser.

ParserRuntimeException() - Constructor for class org.webmacro.parser.ParserRuntimeException

ParserRuntimeException(String) - Constructor for class org.webmacro.parser.ParserRuntimeException

ParserRuntimeException(String, Throwable) - Constructor for class org.webmacro.parser.ParserRuntimeException

PrimitiveArrayIterator - class org.webmacro.util.PrimitiveArrayIterator.

This provides an iterator interface to an array of primitives

PrimitiveArrayIterator(Object) - Constructor for class org.webmacro.util.PrimitiveArrayIterator

Construct an iterator given an enumeration

PropertyException - exception org.webmacro.PropertyException.

A PropertyException indicates some failure to evaluate a property in a context or against some other object.

PropertyException(String) - Constructor for class org.webmacro.PropertyException

PropertyException(String, Throwable) - Constructor for class org.webmacro.PropertyException

PropertyException(String, Throwable, String) - Constructor for class org.webmacro.PropertyException

PropertyException.InvalidTypeException - exception org.webmacro.PropertyException.InvalidTypeException.

Exception thrown when a Variable isn't of the specified class type.

PropertyException.InvalidTypeException(String, Class) - Constructor for class org.webmacro.PropertyException.InvalidTypeException

PropertyException.NoSuchMethodException - exception org.webmacro.PropertyException.NoSuchMethodException.

NoSuchMethodException indicates that the variable did not have the requested method.

PropertyException.NoSuchMethodException(String, String, String) - Constructor for class org.webmacro.PropertyException.NoSuchMethodException

PropertyException.NoSuchMethodWithArgumentsException - exception org.webmacro.PropertyException.NoSuchMethodWithArgumentsException.

NoSuchMethodWithArgumentsException indicates that the variable did not have the a method with the request name and argument list

PropertyException.NoSuchMethodWithArgumentsException(String, String, String) - Constructor for class org.webmacro.PropertyException.NoSuchMethodWithArgumentsException

PropertyException.NoSuchPropertyException - exception org.webmacro.PropertyException.NoSuchPropertyException.

NoSuchPropertyException indicates that the variable did not have the requested property.

PropertyException.NoSuchPropertyException(String, String, String) - Constructor for class org.webmacro.PropertyException.NoSuchPropertyException

PropertyException.NoSuchVariableException - exception org.webmacro.PropertyException.NoSuchVariableException.

NoSuchVariableException indicates that a variable did not exist in the context against which it was being evaluated.

PropertyException.NoSuchVariableException(String) - Constructor for class org.webmacro.PropertyException.NoSuchVariableException

PropertyException.NullToStringException - exception org.webmacro.PropertyException.NullToStringException.

NullStringException indicates that a variable exists but its .toString() method returns null

PropertyException.NullToStringException(String) - Constructor for class org.webmacro.PropertyException.NullToStringException

PropertyException.NullValueException - exception org.webmacro.PropertyException.NullValueException.

NullValueException indicates that a variable or property exists, but evaluated to null in the context against which it was being evaluated.

PropertyException.NullValueException(String) - Constructor for class org.webmacro.PropertyException.NullValueException

PropertyException.RestrictedMethodException - exception org.webmacro.PropertyException.RestrictedMethodException.

RestrictedMethodException indicates that the requested method may not be invoked from a template due to security constraints

PropertyException.RestrictedMethodException(String, String, String) - Constructor for class org.webmacro.PropertyException.RestrictedMethodException

PropertyException.RestrictedPropertyException - exception org.webmacro.PropertyException.RestrictedPropertyException.

RestrictedPropertyException indicates that the requested property may not be invoked from a template due to security constraints

PropertyException.RestrictedPropertyException(String, String, String) - Constructor for class org.webmacro.PropertyException.RestrictedPropertyException

PropertyException.UndefinedVariableException - exception org.webmacro.PropertyException.UndefinedVariableException.

UndefinedVariableException indicates that the variable did not have the requested method.

PropertyException.UndefinedVariableException() - Constructor for class org.webmacro.PropertyException.UndefinedVariableException

PropertyException.VoidValueException - exception org.webmacro.PropertyException.VoidValueException.

VoidValueException indicates that someone tried to use the return value of a void method

PropertyException.VoidValueException() - Constructor for class org.webmacro.PropertyException.VoidValueException

PropertyException.VoidValueException(String) - Constructor for class org.webmacro.PropertyException.VoidValueException

PropertyMethod - class org.webmacro.util.PropertyMethod.

A property method can function as part of a name in a property, and represents a method call that should be used to resolve that portion of the name.

PropertyMethod(String, Object[]) - Constructor for class org.webmacro.util.PropertyMethod

Create a new PropertyMethod

PropertyMethod(String, Macro) - Constructor for class org.webmacro.util.PropertyMethod

Create a new PropertyMethod

PropertyMethodBuilder - class org.webmacro.engine.PropertyMethodBuilder.

PropertyMethodBuilder(String, ListBuilder) - Constructor for class org.webmacro.engine.PropertyMethodBuilder

PropertyOperatorCache - class org.webmacro.engine.PropertyOperatorCache.

PropertyOperatorCache() - Constructor for class org.webmacro.engine.PropertyOperatorCache

Provider - interface org.webmacro.Provider.

A Provider is an object responsible or loading and managing instances of a given type.

Punct_COMMA() - Method in class org.webmacro.parser.WMParser_impl

Punct_EQ() - Method in class org.webmacro.parser.WMParser_impl

Punct_LPAREN() - Method in class org.webmacro.parser.WMParser_impl

Punct_RPAREN() - Method in class org.webmacro.parser.WMParser_impl

parse() - Method in interface org.webmacro.Template

Force the template to parse now.

parse() - Method in class org.webmacro.engine.WMTemplate

Template API

parse() - Method in class org.webmacro.resource.URLTemplate

parseBlock(String, Reader) - Method in class org.webmacro.engine.NullParser

parseBlock(String, Reader) - Method in interface org.webmacro.engine.Parser

Parse the input in ParseTool as far as the grammar for this parser allows, but no farther.

parseBlock(String, Reader) - Method in class org.webmacro.engine.TextParser

parseBlock(String, Reader) - Method in class org.webmacro.parser.WMParser

Parse a block that appears on the supplied input Reader.

parseLocalTemplate(String) - Method in class org.webmacro.util.WMEval

A convenience method to find and parse a template in the local template path.

parseTemplate(String, Reader) - Static method in class org.webmacro.tools.CheckTemplates

pow(int, int) - Static method in class org.webmacro.servlet.MathTool

pow(long, long) - Static method in class org.webmacro.servlet.MathTool

printStackTrace() - Method in class org.webmacro.RethrowableException

printStackTrace(PrintStream) - Method in class org.webmacro.RethrowableException

printStackTrace(PrintWriter) - Method in class org.webmacro.RethrowableException

printStackTrace() - Method in class org.webmacro.RethrowableRuntimeException

printStackTrace(PrintStream) - Method in class org.webmacro.RethrowableRuntimeException

printStackTrace(PrintWriter) - Method in class org.webmacro.RethrowableRuntimeException

processListSetting(String, Settings.ListSettingHandler) - Method in class org.webmacro.util.Settings

Iterate through a list of settings.

processSetting(String, String) - Method in class org.webmacro.util.Settings.ListSettingHandler

put(Object, Class) - Method in class org.webmacro.Context

Convenience method for putting static classes into the context, wraps the class instance in a wrapper

put(Object, Object) - Method in class org.webmacro.Context

Add an object to the context returning the object that was there previously under the same name, if any.

put(Object, int) - Method in class org.webmacro.Context

put(Object, byte) - Method in class org.webmacro.Context

put(Object, short) - Method in class org.webmacro.Context

put(Object, long) - Method in class org.webmacro.Context

put(Object, char) - Method in class org.webmacro.Context

put(Object, float) - Method in class org.webmacro.Context

put(Object, double) - Method in class org.webmacro.Context

put(Object, boolean) - Method in class org.webmacro.Context

put(Object, Object) - Method in interface org.webmacro.resource.CacheManager

Called to put a resource into the cache.

put(Object, Object) - Method in class org.webmacro.resource.ReloadingCacheManager

Put an object in the cache

put(Object, Object) - Method in class org.webmacro.resource.SimpleCacheManager

Put an object in the cache

put(Object, Object) - Method in class org.webmacro.resource.TrivialCacheManager

put(String, String) - Method in class org.webmacro.servlet.CookieJar

Create a new cookie with the supplied name and value and set it in the response header.

put(String, Object) - Method in class org.webmacro.servlet.Form

Unsupported

put(String, Object) - Method in class org.webmacro.servlet.FormList

Unsupported

put(String, Object) - Method in class org.webmacro.servlet.LocaleTool

Unsupported

put(String, Object) - Method in interface org.webmacro.util.Bag

Add an item to the bag

put(Object, Object) - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

putAll(Map) - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

putFunction(String, MethodWrapper) - Method in class org.webmacro.Broker

store a "global function"

putFunction(String, Object, String) - Method in class org.webmacro.Broker

store a "global function" by name

putFunction(String, Object, String) - Method in class org.webmacro.Context

putGlobalFunction(String, Object, String) - Method in class org.webmacro.Context

putMacro(String, MacroDefinition) - Method in class org.webmacro.engine.BuildContext

Add a MacroDefinition to the build context

putMacro(String, MacroDefinition) - Method in class org.webmacro.engine.MacroBuildContext

Q

QCHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

QS - Static variable in interface org.webmacro.parser.WMParser_implConstants

QS_TEXT - Static variable in interface org.webmacro.parser.WMParser_implConstants

QUOTE - Static variable in interface org.webmacro.parser.WMParser_implConstants

QuotedString() - Method in class org.webmacro.parser.WMParser_impl

QuotedStringBuilder - class org.webmacro.engine.QuotedStringBuilder.

QuotedStringBuilder() - Constructor for class org.webmacro.engine.QuotedStringBuilder

R

RBRACE - Static variable in interface org.webmacro.parser.WMParser_implConstants

RBRACKET - Static variable in interface org.webmacro.parser.WMParser_implConstants

RCS - Static variable in class org.webmacro.resource.URLTemplate

CVS revision

RCS - Static variable in class org.webmacro.resource.URLTemplateProvider

CVS Revision tag

RCS - Static variable in class org.webmacro.servlet.LocaleTool

RCS - Static variable in class org.webmacro.util.NativeAsciiReader

RESTOFLINE - Static variable in interface org.webmacro.parser.WMParser_implConstants

RPAREN - Static variable in interface org.webmacro.parser.WMParser_implConstants

RValue() - Method in class org.webmacro.parser.WMParser_impl

ReInit(Reader, int, int, int) - Method in class org.webmacro.parser.ASCII_CharStream

ReInit(Reader, int, int) - Method in class org.webmacro.parser.ASCII_CharStream

ReInit(InputStream, int, int, int) - Method in class org.webmacro.parser.ASCII_CharStream

ReInit(InputStream, int, int) - Method in class org.webmacro.parser.ASCII_CharStream

ReInit(Reader, int, int, int) - Method in class org.webmacro.parser.BackupCharStream

ReInit(Reader, int, int) - Method in class org.webmacro.parser.BackupCharStream

ReInit(Reader) - Method in class org.webmacro.parser.BackupCharStream

ReInit(InputStream, int, int, int) - Method in class org.webmacro.parser.BackupCharStream

ReInit(InputStream, int, int) - Method in class org.webmacro.parser.BackupCharStream

ReInit(String, Reader) - Method in class org.webmacro.parser.WMParser_impl

ReInit(CharStream) - Method in class org.webmacro.parser.WMParser_impl

ReInit(WMParser_implTokenManager) - Method in class org.webmacro.parser.WMParser_impl

ReInit(CharStream) - Method in class org.webmacro.parser.WMParser_implTokenManager

ReInit(CharStream, int) - Method in class org.webmacro.parser.WMParser_implTokenManager

RelOp() - Method in class org.webmacro.parser.WMParser_impl

ReloadDelayDecorator - class org.webmacro.resource.ReloadDelayDecorator.

Utility class to handle creation of TimedReloadContext.
TimedReloadContext objects are used to prevent a cached resource of being checked for modification all the time, but only checks for in given intervals.

ReloadDelayDecorator() - Constructor for class org.webmacro.resource.ReloadDelayDecorator

ReloadingCacheManager - class org.webmacro.resource.ReloadingCacheManager.

ReloadingCacheManager -- a cache manager which supports reloading and expiration, backed by a ConcurrentHashMap.

ReloadingCacheManager() - Constructor for class org.webmacro.resource.ReloadingCacheManager

RequestTool - class org.webmacro.servlet.RequestTool.

Provide Template with access to form data.

RequestTool() - Constructor for class org.webmacro.servlet.RequestTool

ResourceException - exception org.webmacro.ResourceException.

Resource could not be loaded for some reason

ResourceException(String, Exception) - Constructor for class org.webmacro.ResourceException

ResourceException(String) - Constructor for class org.webmacro.ResourceException

ResourceLoader - interface org.webmacro.resource.ResourceLoader.

Methods to be implemented by a resource loader, which will work with a cache manager.

ResponseTool - class org.webmacro.servlet.ResponseTool.

Provide Template with access to form data.

ResponseTool() - Constructor for class org.webmacro.servlet.ResponseTool

RethrowableException - exception org.webmacro.RethrowableException.

RethrowableException A standard exception, inherited from Exception, which also includes a constructor of the form Exception(String, Exception) which allows one exception to wrap another without throwing away useful debugging information.

RethrowableException() - Constructor for class org.webmacro.RethrowableException

RethrowableException(String) - Constructor for class org.webmacro.RethrowableException

RethrowableException(String, Throwable) - Constructor for class org.webmacro.RethrowableException

RethrowableRuntimeException - exception org.webmacro.RethrowableRuntimeException.

RethrowableRuntimeException A standard exception, inherited from RuntimeException, which also includes a constructor of the form Exception(String, Exception) which allows one exception to wrap another without throwing away useful debugging information.

RethrowableRuntimeException() - Constructor for class org.webmacro.RethrowableRuntimeException

RethrowableRuntimeException(String) - Constructor for class org.webmacro.RethrowableRuntimeException

RethrowableRuntimeException(String, Throwable) - Constructor for class org.webmacro.RethrowableRuntimeException

random(int, int) - Static method in class org.webmacro.servlet.MathTool

Creates a pseudo-random Integer between start and end, inclusive

read(char[], int, int) - Method in class org.webmacro.util.NativeAsciiReader

Read a sequence of characters into the given buffer.

readChar() - Method in class org.webmacro.parser.ASCII_CharStream

readChar() - Method in class org.webmacro.parser.BackupCharStream

readChar() - Method in interface org.webmacro.parser.CharStream

Returns the next character from the selected input.

refreshGlobalContext() - Method in class org.webmacro.servlet.TemplateServlet

Call this to refresh the global context.

register(Object, Broker) - Static method in class org.webmacro.Broker

Used to maintain a weak map mapping the partition _key to the Broker.

register(String, String) - Method in class org.webmacro.engine.ParserProvider

Register a new parser class,

registerAutoContextVariable(String, ContextAutoLoader) - Method in class org.webmacro.Broker

registerDescriptor(DirectiveDescriptor, String) - Method in class org.webmacro.directive.DirectiveProvider

Register an org.webmacro.directive.DirectiveDescriptor to be used as if it were a real Directive named dirName.

registerDirective(String, String) - Method in class org.webmacro.directive.DirectiveProvider

Register a new directive class, so that a builder of this type can be retrieved later.

release() - Method in class org.webmacro.adapter.jsp.TemplateTag

Reset the tag

remove(Object) - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

remove() - Method in class org.webmacro.engine.BlockBuilder.BBIterator

remove(int) - Method in class org.webmacro.engine.BlockBuilder

remove(String) - Method in class org.webmacro.servlet.Form

Unsupported

remove(String) - Method in class org.webmacro.servlet.FormList

Unsupported

remove(String) - Method in class org.webmacro.servlet.LocaleTool

Unsupported

remove() - Method in class org.webmacro.util.ArrayIterator

Unsupported

remove(String) - Method in interface org.webmacro.util.Bag

Remove an item from the bag

remove(Object) - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

remove() - Method in class org.webmacro.util.EnumIterator

Unsupported

remove() - Method in class org.webmacro.util.PrimitiveArrayIterator

Unsupported

removeObserver(LogSystem) - Method in class org.webmacro.util.AbstractLogFile

removeObserver(LogSystem) - Method in class org.webmacro.util.CommonsLoggingTarget

removeObserver(LogSystem) - Method in interface org.webmacro.util.LogTarget

A LogSystem may remove itself through this method if it de-registeres the LogTarget.

removeTarget(LogTarget) - Method in class org.webmacro.util.LogSystem

Remove a LogTarget from the LogSystem.

renderMergedTemplateModel(Map, HttpServletRequest, HttpServletResponse) - Method in class org.webmacro.adapter.spring.WebMacroView

Render the template

repeating - Variable in class org.webmacro.directive.Directive.OptionChoice

repeating - Variable in class org.webmacro.directive.Directive.Subdirective

replace(String, String, String) - Static method in class org.webmacro.servlet.TextTool

replace all occurrences of from to to in src.

requestName - Variable in class org.webmacro.servlet.TemplateServlet

The name that identifies the per-request context.

requestTemplate - Variable in class org.webmacro.servlet.TemplateServlet

The per-request template.

requiredViewClass() - Method in class org.webmacro.adapter.spring.WebMacroViewResolver

Requires WebMacroView.

reset(OutputStream) - Method in class org.webmacro.FastWriter

Reset the fastwriter, clearing any contents that have been generated so far.

reset() - Method in class org.webmacro.util.ByteBufferOutputStream

Move the read point of the current buffer back to the beginning of the buffer.

rtrim(String) - Static method in class org.webmacro.servlet.TextTool

remove the trailing whitespace from a string

rtrimBlock(String) - Static method in class org.webmacro.servlet.TextTool

remove the trailing whitespace from each line in a block of text

run(String) - Method in class org.webmacro.tools.EvalTemplates

Evaluates a single template file argument.

run(String, String, boolean, String) - Method in class org.webmacro.tools.EvalTemplates

Evaluates a single template file argument.

S

SAFE_UNICODE_ENCODING - Static variable in class org.webmacro.FastWriter

This encoding is either UTF16-BE or, if the platform does not support it, UTF8.

SEMI - Static variable in interface org.webmacro.parser.WMParser_implConstants

SETTINGS_PREFIX - Static variable in class org.webmacro.Broker

SHORT - Static variable in class org.webmacro.util.CastUtil

SLASH - Static variable in interface org.webmacro.parser.WMParser_implConstants

SQS - Static variable in interface org.webmacro.parser.WMParser_implConstants

SQS_TEXT - Static variable in interface org.webmacro.parser.WMParser_implConstants

SQUOTE - Static variable in interface org.webmacro.parser.WMParser_implConstants

STUFF - Static variable in interface org.webmacro.parser.WMParser_implConstants

SelectList - class org.webmacro.util.SelectList.

Selects from a list of things as an enumerator.

SelectList(Object[], int) - Constructor for class org.webmacro.util.SelectList

Servlet20Broker - class org.webmacro.servlet.Servlet20Broker.

An implementation of Broker tailored for Servlet 2.0/2.1 environments.

Servlet20Broker(ServletContext, ClassLoader, Properties) - Constructor for class org.webmacro.servlet.Servlet20Broker

Servlet22Broker - class org.webmacro.servlet.Servlet22Broker.

An implementation of Broker tailored for Servlet 2.2 environments.

Servlet22Broker(ServletContext, ClassLoader, Properties) - Constructor for class org.webmacro.servlet.Servlet22Broker

Creates the broker looking in WEB-INF first for WebMacro.properties before looking in the application root.

ServletBroker - class org.webmacro.servlet.ServletBroker.

The base broker for Servlets and web applications.

ServletBroker(ServletContext) - Constructor for class org.webmacro.servlet.ServletBroker

ServletBroker.PropertiesPair - class org.webmacro.servlet.ServletBroker.PropertiesPair.

ServletBroker.PropertiesPair(Object, Properties) - Constructor for class org.webmacro.servlet.ServletBroker.PropertiesPair

ServletContextTemplateLoader - class org.webmacro.resource.ServletContextTemplateLoader.

Implementation of TemplateLoader that loads template from web-apps.

ServletContextTemplateLoader() - Constructor for class org.webmacro.resource.ServletContextTemplateLoader

ServletLog - class org.webmacro.servlet.ServletLog.

Implementation of AbstractLogFile which directs log information to the servlet log.

ServletLog(ServletContext, Settings) - Constructor for class org.webmacro.servlet.ServletLog

ServletRouter - interface org.webmacro.servlet.ServletRouter.

Implements a router dispatcher pattern for a servlet handling a request in a WebMacro setting.

SessionTool - class org.webmacro.servlet.SessionTool.

Provide Template with access to the HttpSession associated with the current request.

SessionTool() - Constructor for class org.webmacro.servlet.SessionTool

SetDirective - class org.webmacro.directive.SetDirective.

Implements the setting of a variable.

SetDirective() - Constructor for class org.webmacro.directive.SetDirective

SetDirective(Variable, Object) - Constructor for class org.webmacro.directive.SetDirective

SetblockDirective - class org.webmacro.directive.SetblockDirective.

Allows setting a variable to a block of template script.

SetblockDirective() - Constructor for class org.webmacro.directive.SetblockDirective

SetpropsDirective - class org.webmacro.directive.SetpropsDirective.

SetpropsDirective() - Constructor for class org.webmacro.directive.SetpropsDirective

Settings - class org.webmacro.util.Settings.

Models the settings from a property object.

Settings() - Constructor for class org.webmacro.util.Settings

Create an empty Settings object

Settings(String) - Constructor for class org.webmacro.util.Settings

Search for the named settingsFile on the classpath and instantiate a Settings object based on its values

Settings(URL) - Constructor for class org.webmacro.util.Settings

Search for the named settingsFile from the supplied URL and instantiate a Settings object based on its values

Settings(Properties) - Constructor for class org.webmacro.util.Settings

Instantiate a new Settings object using the properties supplied as the settings values.

Settings(Settings) - Constructor for class org.webmacro.util.Settings

Instantaite a new Settings object using the supplied Settings as the defaults

Settings.ListSettingHandler - class org.webmacro.util.Settings.ListSettingHandler.

Settings.ListSettingHandler() - Constructor for class org.webmacro.util.Settings.ListSettingHandler

SimpleCacheManager - class org.webmacro.resource.SimpleCacheManager.

SimpleCacheManager -- a basic cache manager backed by ConcurrentHashMap which does not support reloading, or expiration

SimpleCacheManager() - Constructor for class org.webmacro.resource.SimpleCacheManager

SparseProperties - class org.webmacro.util.SparseProperties.

Implement a behavior allowing for undefined properties to return a useful default value such as "" for a string, "0.00" for numeric properties, and so forth.

SparseProperties() - Constructor for class org.webmacro.util.SparseProperties

SparseProperties(Properties) - Constructor for class org.webmacro.util.SparseProperties

SparseProperties(Object) - Constructor for class org.webmacro.util.SparseProperties

SparseProperties(Properties, Object) - Constructor for class org.webmacro.util.SparseProperties

StaticClassWrapper - class org.webmacro.engine.StaticClassWrapper.

Simple class for wrapping a Class instance of a static class.

StaticClassWrapper(Class) - Constructor for class org.webmacro.engine.StaticClassWrapper

Creates new StaticClassWrapper

StreamTemplate - class org.webmacro.engine.StreamTemplate.

StreamTempaltes are constructed with a stream from which they read their data.

StreamTemplate(Broker, Reader) - Constructor for class org.webmacro.engine.StreamTemplate

Instantiate a template based on the specified stream

StreamTemplate(Broker, InputStream) - Constructor for class org.webmacro.engine.StreamTemplate

Instantiate a template based on the specified stream Will use webmacro's default encoding.

StreamTemplate(Broker, InputStream, String) - Constructor for class org.webmacro.engine.StreamTemplate

Instantiate a template based on the specified stream If encoding is null, webmacro's default encoding will be used.

StringArg() - Method in class org.webmacro.parser.WMParser_impl

StringMacro - class org.webmacro.engine.StringMacro.

StringMacro(String) - Constructor for class org.webmacro.engine.StringMacro

StringMacroAdapter - class org.webmacro.engine.StringMacroAdapter.

Looks like a Macro, but really it's a String.

StringMacroAdapter(String) - Constructor for class org.webmacro.engine.StringMacroAdapter

StringTemplate - class org.webmacro.engine.StringTemplate.

StringTemplate objects read their template data from a string.

StringTemplate(Broker, String) - Constructor for class org.webmacro.engine.StringTemplate

Instantiate a template.

StringTemplate(Broker, String, String) - Constructor for class org.webmacro.engine.StringTemplate

Instantiate a template.

SubSettings - class org.webmacro.util.SubSettings.

Models the subsettings of a setting.

SubSettings(Settings, String) - Constructor for class org.webmacro.util.SubSettings

Get a subset of the settings in this Settings.

SubdirectiveStart() - Method in class org.webmacro.parser.WMParser_impl

SwitchTo(int) - Method in class org.webmacro.parser.WMParser_implTokenManager

set(Object[], Object) - Method in class org.webmacro.Context

Set the named property in the Context.

set(String, Object) - Method in class org.webmacro.servlet.CookieJar

Calls put

setArg(int, Object) - Method in class org.webmacro.directive.ArgsHolder

Set the argument whose id is the specified id.

setArg(int, Object) - Method in interface org.webmacro.directive.DirectiveArgs

setArg(int, Object) - Method in class org.webmacro.directive.DirectiveBuilder

Set the argument whose id is the specified id.

setBrokerLocal(Object, Object) - Method in class org.webmacro.Broker

Store a _key/value in this Broker.

setClasspath(Path) - Method in class org.webmacro.tools.WMTemplateAntTask

setClasspathRef(Reference) - Method in class org.webmacro.tools.WMTemplateAntTask

setConfig(String) - Method in class org.webmacro.URLTemplateLoader

setConfig(String) - Method in class org.webmacro.resource.BrokerTemplateLoader

setConfig(String) - Method in class org.webmacro.resource.ClassPathTemplateLoader

setConfig(String) - Method in class org.webmacro.resource.FileTemplateLoader

setConfig(String) - Method in class org.webmacro.resource.ServletContextTemplateLoader

setConfig(String) - Method in interface org.webmacro.resource.TemplateLoader

Set the config options for this template loader.

setConfig(String) - Method in class org.webmacro.resource.TemplatePathTemplateLoader

setContext(Object) - Method in class org.webmacro.adapter.jsp.TemplateTag

setContextLocation(String) - Method in class org.webmacro.WebMacroException

Record the line and column info from the template that caused this ProeprtyException to be thrown.

setCookie(String, String) - Method in class org.webmacro.servlet.WebContext

send a cookie in the response

setCurrentContext(Context) - Method in class org.webmacro.util.WMEval

Supplies a context to be parsed currentTemplate directly.

setCurrentTemplate(Template) - Method in class org.webmacro.util.WMEval

Supplies the parsed currentTemplate directly.

setDebugStream(PrintStream) - Method in class org.webmacro.parser.WMParser_implTokenManager

setElementAt(Object, int) - Method in class org.webmacro.engine.BlockBuilder

setEvaluationExceptionHandler(EvaluationExceptionHandler) - Method in class org.webmacro.Broker

Set a new EvaluationExceptionHandler

setEvaluationExceptionHandler(EvaluationExceptionHandler) - Method in class org.webmacro.Context

Set a new EvaluationExceptionHandler

setFailFast(boolean) - Method in class org.webmacro.adapter.jsp.TemplateTag

setLocale(HttpServletResponse, Locale) - Method in class org.webmacro.servlet.WMServlet

Set the locale on the response.

setLogLevel(int) - Method in class org.webmacro.util.AbstractLogFile

Set the log level for this Logfile.

setLogLevel(String, int) - Method in class org.webmacro.util.AbstractLogFile

Set the log level for a specific category name.

setMap(Map) - Method in class org.webmacro.Context

Set the underlying Map object.

setMessage(String) - Method in class org.webmacro.PropertyException.UndefinedVariableException

setMessage(String) - Method in class org.webmacro.PropertyException

setName(String) - Method in interface org.webmacro.Template

setName(String) - Method in class org.webmacro.engine.StreamTemplate

setName(String) - Method in class org.webmacro.engine.StringTemplate

setName(String) - Method in class org.webmacro.engine.TestObject

setName(String) - Method in class org.webmacro.engine.WMTemplate

Set the name for this template.

setOptional(boolean) - Method in class org.webmacro.directive.Directive.ArgDescriptor

setOutputStream(OutputStream) - Method in class org.webmacro.util.WMEval

Sets the output stream to be different than the default, System.out.

setParam(String, Object) - Method in interface org.webmacro.Template

set a parameter.

setParam(String, Object) - Method in class org.webmacro.engine.WMTemplate

setProperty(Object, Object) - Method in class org.webmacro.Context

Same as put(name,value) but can be overridden by subclasses to do something different

setProperty(Object[], Object) - Method in class org.webmacro.Context

Same as set(Object names[], Object value) but can be overridden by subclasses to behave differently

setProperty(Context, Object, Object[], int, Object) - Method in class org.webmacro.engine.PropertyOperatorCache

Given a property description name, attempt to set the property value to the supplied object.

setProperty(Context, Object, Object[], Object) - Method in class org.webmacro.engine.PropertyOperatorCache

Calls setProperty(context, names, 0, value)

setReload(boolean) - Method in class org.webmacro.resource.BrokerTemplateProviderHelper

setReloadContext(CacheReloadContext) - Method in class org.webmacro.resource.CacheElement

setSrc(String) - Method in class org.webmacro.adapter.jsp.TemplateTag

Set the src of an external template to use

setSubordinateArgs(int) - Method in class org.webmacro.directive.Directive.ArgDescriptor

setTemplateName(String) - Method in class org.webmacro.engine.Block

setTraceExceptions(boolean) - Method in class org.webmacro.util.AbstractLogFile

Set whether this LogFile traces exceptions.

setValue(Context, Object) - Method in class org.webmacro.engine.ConstantPropertyVariable

Look up my the value of this variable in the specified Map, possibly using introspection, and set it to the supplied value.

setValue(Context, Object) - Method in class org.webmacro.engine.FunctionVariable

The code to set the value represented by the variable in the supplied context.

setValue(Context, Object) - Method in class org.webmacro.engine.MacroPropertyVariable

Look up my the value of this variable in the specified Map, possibly using introspection, and set it to the supplied value.

setValue(Context, Object) - Method in class org.webmacro.engine.Variable

The code to set the value represented by the variable in the supplied context.

setVariableType(String, Object) - Method in class org.webmacro.engine.BuildContext

Declare whether the named variable is to be treated as a tool, local variable, or property variable type.

setWebMacro(WebMacro) - Method in class org.webmacro.adapter.spring.WebMacroView

setWebMacro(WebMacro) - Method in class org.webmacro.adapter.spring.WebMacroViewResolver

You can programmatically supply a WebMacro instance if your configuration is performed during execution rather than exclusively from a Spring context

shouldReload() - Method in class org.webmacro.resource.CacheReloadContext

The CacheManager calls shouldReload to ask the reference whether it has changed since we loaded it.

shouldReload() - Method in class org.webmacro.resource.TemplateProvider.FTReloadContext

shouldReload() - Method in class org.webmacro.resource.TimedReloadContext

Check, whether the underlying resource should be reloaded.

shouldReload() - Method in class org.webmacro.resource.URLTemplate

URL based templates are difficult to detect as changed in general, but the two special cases can be determined for reloading.

shouldReload(String) - Method in class org.webmacro.resource.URLTemplateProvider

show(String) - Method in class org.webmacro.engine.TestObject

show(Object) - Method in class org.webmacro.engine.TestObject

show(long) - Method in class org.webmacro.engine.TestObject

show(int) - Method in class org.webmacro.engine.TestObject

size() - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

size() - Method in class org.webmacro.FastWriter

Return the number of bytes that would be written out if flush() is called.

size() - Method in class org.webmacro.engine.BlockBuilder

size(Object[]) - Static method in class org.webmacro.servlet.ListUtil

size(List) - Static method in class org.webmacro.servlet.ListUtil

size(Object) - Static method in class org.webmacro.servlet.ListUtil

size() - Method in class org.webmacro.util.ByteBufferOutputStream

How many bytes currently in the buffer

size() - Method in class org.webmacro.util.DictionaryTool

Forward call to Dictionary

specialConstructor - Variable in class org.webmacro.parser.ParseException

This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).

specialToken - Variable in class org.webmacro.parser.Token

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

split(List, int) - Static method in class org.webmacro.servlet.ListUtil

Splits list into multiple lists of equal size.

split(List, int, boolean) - Static method in class org.webmacro.servlet.ListUtil

Splits list into multiple lists of equal size.

split(List, int, Object) - Static method in class org.webmacro.servlet.ListUtil

Splits list into multiple lists of equal size.

split(List, int, boolean, Object) - Static method in class org.webmacro.servlet.ListUtil

Splits list into multiple lists of equal size.

split(Object[], int) - Static method in class org.webmacro.servlet.ListUtil

Splits array into multiple arrays of equal size.

split(Object[], int, boolean) - Static method in class org.webmacro.servlet.ListUtil

Splits array into multiple arrays of equal size.

split(Object[], int, Object) - Static method in class org.webmacro.servlet.ListUtil

Splits array into multiple arrays of equal size.

split(Object[], int, boolean, Object) - Static method in class org.webmacro.servlet.ListUtil

Splits array into multiple arrays of equal size.

split(String, String) - Static method in class org.webmacro.servlet.TextTool

Split the input String into a String[] at each instance of delimiter.

start() - Method in class org.webmacro.servlet.WMServlet

Override this method to implement any startup/init code you require.

staticFlag - Static variable in class org.webmacro.parser.ASCII_CharStream

staticFlag - Static variable in class org.webmacro.parser.BackupCharStream

stop() - Method in class org.webmacro.servlet.WMServlet

Override this method to implement any shutdown code you require.

streamToString(InputStream) - Static method in class org.webmacro.servlet.TextTool

Write the bytes of the specified InputStream into a String using the default character encoding of your platform.

streamToString(InputStream, String) - Static method in class org.webmacro.servlet.TextTool

Write the bytes of the specified InputStream into a String using the specified character encoding.

stringArray - Static variable in class org.webmacro.util.Settings

subdirectiveOk(int) - Method in class org.webmacro.directive.DirectiveBuilder

Check to see if the specified subdirective is OK at this point.

subdirectives - Variable in class org.webmacro.directive.DirectiveDescriptor

subordinateArgs - Variable in class org.webmacro.directive.Directive.ArgDescriptor

subscribe(String, String, int) - Method in class org.webmacro.util.AbstractLogFile

subscribe(String, String, int) - Method in class org.webmacro.util.CommonsLoggingTarget

subscribe(String, String, int) - Method in interface org.webmacro.util.LogTarget

Return true or false if this log target would like to receive log messages for the named category, type, and logLevel.

supportsReload() - Method in interface org.webmacro.resource.CacheManager

Does this cache manager support reloading of resources if the underlying resource has changed?

supportsReload() - Method in class org.webmacro.resource.ReloadingCacheManager

supportsReload() - Method in class org.webmacro.resource.SimpleCacheManager

supportsReload() - Method in class org.webmacro.resource.TrivialCacheManager

T

TEMPLATE_INPUT_ENCODING - Static variable in class org.webmacro.WMConstants

TEMPLATE_LOCALE - Static variable in class org.webmacro.WMConstants

TEMPLATE_OUTPUT_ENCODING - Static variable in class org.webmacro.WMConstants

TIME - Static variable in class org.webmacro.util.Clock

Every tick interval the following variable is updated with the current system time

TRUE - Static variable in interface org.webmacro.parser.WMParser_implConstants

TYPE - Static variable in class org.webmacro.engine.FunctionVariable

TYPE - Static variable in class org.webmacro.util.EncoderProvider

The provider type for this provider.

TYPE_CLASSNAME - Static variable in class org.webmacro.directive.TypeDirective

TYPE_DYNAMIC - Static variable in class org.webmacro.directive.IncludeDirective

the file to include is unknown

TYPE_MACRO - Static variable in class org.webmacro.directive.IncludeDirective

the file to include as a Template containing #macro's

TYPE_OBJECT - Static variable in class org.webmacro.directive.TypeDirective

TYPE_REQUIRED - Static variable in class org.webmacro.directive.TypeDirective

TYPE_TEMPLATE - Static variable in class org.webmacro.directive.IncludeDirective

the file to include is a Template

TYPE_TEXT - Static variable in class org.webmacro.directive.IncludeDirective

the file to include is a static file.

Template - interface org.webmacro.Template.

Defines the type of object which contains WebMacro script, text, blocks to be evaluated.

TemplateDumper - class org.webmacro.engine.TemplateDumper.

TemplateDumper() - Constructor for class org.webmacro.engine.TemplateDumper

TemplateEvalAntTask - class org.webmacro.tools.TemplateEvalAntTask.

Subclass of WMTemplateAntTask for naming EvalTemplates as the ant task to run.

TemplateEvalAntTask() - Constructor for class org.webmacro.tools.TemplateEvalAntTask

TemplateException - exception org.webmacro.TemplateException.

Exception raised on discovery of a parsing error.

TemplateException() - Constructor for class org.webmacro.TemplateException

TemplateException(String) - Constructor for class org.webmacro.TemplateException

Create a new exception

TemplateException(String, Throwable) - Constructor for class org.webmacro.TemplateException

Create a new exception, wrapping another exception

TemplateLoader - interface org.webmacro.resource.TemplateLoader.

Interface for template loaders.

TemplateLoaderFactory - interface org.webmacro.resource.TemplateLoaderFactory.

Interface for template loader factories.

TemplateLoaderHelper - class org.webmacro.resource.TemplateLoaderHelper.

Helper class for template loaders to actuall load a Template.

TemplateLoaderHelper() - Constructor for class org.webmacro.resource.TemplateLoaderHelper

Construct a new TemplateLoaderHelper object

TemplatePathTemplateLoader - class org.webmacro.resource.TemplatePathTemplateLoader.

Implementation of TemplateLoader that loads templates from a list of paths specified in the TemplatePath setting.

TemplatePathTemplateLoader() - Constructor for class org.webmacro.resource.TemplatePathTemplateLoader

TemplateProvider - class org.webmacro.resource.TemplateProvider.

The TemplateProvider is the WebMacro class responsible for loading templates.

TemplateProvider() - Constructor for class org.webmacro.resource.TemplateProvider

TemplateProvider.FTReloadContext - class org.webmacro.resource.TemplateProvider.FTReloadContext.

ReloadContext for file templates.

TemplateProvider.FTReloadContext(File, long) - Constructor for class org.webmacro.resource.TemplateProvider.FTReloadContext

TemplateServlet - class org.webmacro.servlet.TemplateServlet.

TemplateServlet provides a servlet to evaluate templates directly as long as the template type or types is mapped to this servlet.

TemplateServlet() - Constructor for class org.webmacro.servlet.TemplateServlet

TemplateTag - class org.webmacro.adapter.jsp.TemplateTag.

JSP Custom Tag for evaluating WebMacro templates inside a JSP page, or from external files.

TemplateTag() - Constructor for class org.webmacro.adapter.jsp.TemplateTag

TemplateTool - class org.webmacro.servlet.TemplateTool.

This is an experimental context tool that allows templates to be used as macros.

TemplateTool() - Constructor for class org.webmacro.servlet.TemplateTool

Creates new TemplateTool

TemplateTool.MacroTemplate - class org.webmacro.servlet.TemplateTool.MacroTemplate.

Encapsulates a template and a context, allowing a template to be used like a function or "macro".

TemplateTool.MacroTemplate(Context, Template) - Constructor for class org.webmacro.servlet.TemplateTool.MacroTemplate

Constructor

TemplateTool.MacroTemplate(Context, String) - Constructor for class org.webmacro.servlet.TemplateTool.MacroTemplate

Construct a MacroTemplate with a StringTemplate

TemplateTool.MacroTemplateFactory - class org.webmacro.servlet.TemplateTool.MacroTemplateFactory.

A factory class for creating MacroTemplate objects.

TemplateTool.MacroTemplateFactory(Context) - Constructor for class org.webmacro.servlet.TemplateTool.MacroTemplateFactory

Constructor

TemplateVisitor - class org.webmacro.TemplateVisitor.

TemplateVisitor() - Constructor for class org.webmacro.TemplateVisitor

TempletDirective - class org.webmacro.directive.TempletDirective.

This directive allows a block within a template to be reused as a "templet" that can be invoked using the #eval directive.

TempletDirective() - Constructor for class org.webmacro.directive.TempletDirective

Creates a new instance of TempletDirective

Term() - Method in class org.webmacro.parser.WMParser_impl

TestObject - class org.webmacro.engine.TestObject.

This class exists for testing purposes only

TestObject(String) - Constructor for class org.webmacro.engine.TestObject

TestObject(String, boolean) - Constructor for class org.webmacro.engine.TestObject

TextDirective - class org.webmacro.directive.TextDirective.

Implements the treatment of a block as text not subject to evaluation.

TextDirective() - Constructor for class org.webmacro.directive.TextDirective

TextParser - class org.webmacro.engine.TextParser.

This parser returns all the input as is

TextParser(Broker) - Constructor for class org.webmacro.engine.TextParser

TextTool - class org.webmacro.servlet.TextTool.

A ContextTool for String manipulation.

TextTool() - Constructor for class org.webmacro.servlet.TextTool

default contsructor.

TextTool(Context) - Constructor for class org.webmacro.servlet.TextTool

public constructor.

TimedReloadContext - class org.webmacro.resource.TimedReloadContext.

TimedReloadContext acts as an Decorator for Reload context to support cache resources that are expensive to check for change.

TimedReloadContext(CacheReloadContext, long) - Constructor for class org.webmacro.resource.TimedReloadContext

Construct a new TimedReloadContext decorator.

Token - class org.webmacro.parser.Token.

Describes the input token stream.

Token() - Constructor for class org.webmacro.parser.Token

TokenMgrError - error org.webmacro.parser.TokenMgrError.

TokenMgrError() - Constructor for class org.webmacro.parser.TokenMgrError

TokenMgrError(String, int) - Constructor for class org.webmacro.parser.TokenMgrError

TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for class org.webmacro.parser.TokenMgrError

TrivialCacheManager - class org.webmacro.resource.TrivialCacheManager.

TrivialCacheManager() - Constructor for class org.webmacro.resource.TrivialCacheManager

TypeDirective - class org.webmacro.directive.TypeDirective.

TypeDirective allows the programmer (or template designer) to ensure objects placed into the Context are of the required class type.

TypeDirective() - Constructor for class org.webmacro.directive.TypeDirective

TypeTool - class org.webmacro.servlet.TypeTool.

Provide templates a way to cast objects to primitive type wrappers

TypeTool() - Constructor for class org.webmacro.servlet.TypeTool

text - Variable in class org.webmacro.util.Encoder.Block

toBoolean(Object) - Static method in class org.webmacro.util.CastUtil

toByte(Object) - Static method in class org.webmacro.util.CastUtil

toByteArray() - Method in class org.webmacro.FastWriter

Copy the contents written so far into a byte array.

toChar(Object) - Static method in class org.webmacro.util.CastUtil

toDouble(Object) - Static method in class org.webmacro.util.CastUtil

toFloat(Object) - Static method in class org.webmacro.util.CastUtil

toInt(Object) - Static method in class org.webmacro.util.CastUtil

toList(Object) - Static method in class org.webmacro.servlet.ListUtil

Returns a List for any Object.

toLong(Object) - Static method in class org.webmacro.util.CastUtil

toLowerCase(String) - Static method in class org.webmacro.servlet.TextTool

Returns a new string which is in lower case.

toShort(Object) - Static method in class org.webmacro.util.CastUtil

toString() - Method in class org.webmacro.Broker

Explain myself

toString() - Method in class org.webmacro.Context

Dump the variables (and their values) contained in this Context.

toString() - Method in class org.webmacro.FastWriter

Copy the contents written so far into a String.

toString() - Method in class org.webmacro.WM

toString() - Method in class org.webmacro.engine.ConstantPropertyVariable

Return a string representation naming the variable for debugging purposes.

toString() - Method in class org.webmacro.engine.FileTemplate

Return a name for this template.

toString() - Method in class org.webmacro.engine.FunctionVariable

Return the String name of the variable prefixed with a string representing its type, in this case "function:".

toString() - Method in class org.webmacro.engine.MacroAdapter

toString() - Method in class org.webmacro.engine.MacroPropertyVariable

Return a string representation naming the variable for debugging purposes.

toString() - Method in class org.webmacro.engine.ParamBuilder

toString() - Method in class org.webmacro.engine.StreamTemplate

Return a name for this template.

toString() - Method in class org.webmacro.engine.StringMacroAdapter

toString() - Method in class org.webmacro.engine.StringTemplate

Return a name for this template.

toString() - Method in class org.webmacro.engine.UndefinedMacro

toString() - Method in class org.webmacro.engine.Variable

Return the String name of the variable prefixed with a string representing its type.

toString() - Method in class org.webmacro.engine.WMTemplate

Return a name for this template.

toString() - Method in class org.webmacro.parser.Token

Returns the image.

toString() - Method in class org.webmacro.resource.CachingProvider

toString() - Method in class org.webmacro.resource.ReloadingCacheManager

toString() - Method in class org.webmacro.resource.SimpleCacheManager

toString() - Method in class org.webmacro.resource.URLTemplate

Return a name for this template.

toString() - Method in class org.webmacro.servlet.Form

Return a String listing all the HTTP request parameter names and their values.

toString() - Method in interface org.webmacro.servlet.Handler

You SHOULD override this method and provide a short name by which your handler is known.

toString() - Method in class org.webmacro.util.AbstractLogFile

toString() - Method in class org.webmacro.util.ByteBufferOutputStream

Convert the bytes to a String using the default encoding

toString(String) - Method in class org.webmacro.util.ByteBufferOutputStream

Convert the bytes to a String using the specified encodign

toString(Object) - Static method in class org.webmacro.util.CastUtil

toString() - Method in class org.webmacro.util.LogSource

Explain myself

toString() - Method in class org.webmacro.util.PropertyMethod

Return a signature of this method

toString() - Method in class org.webmacro.util.SelectList

toUpperCase(String) - Static method in class org.webmacro.servlet.TextTool

Returns a new string which is in upper case.

token - Variable in class org.webmacro.parser.WMParser_impl

tokenImage - Variable in class org.webmacro.parser.ParseException

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

tokenImage - Static variable in interface org.webmacro.parser.WMParser_implConstants

token_source - Variable in class org.webmacro.parser.WMParser_impl

transposeSplit(Object[], int) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits array into multiple arrays of equal size.

transposeSplit(Object[], int, boolean) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits array into multiple arrays of equal size.

transposeSplit(Object[], int, Object) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits array into multiple arrays of equal size.

transposeSplit(Object[], int, boolean, Object) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits array into multiple arrays of equal size.

transposeSplit(List, int) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits list into multiple lists of equal size.

transposeSplit(List, int, boolean) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits list into multiple lists of equal size.

transposeSplit(List, int, Object) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits list into multiple lists of equal size.

transposeSplit(List, int, boolean, Object) - Static method in class org.webmacro.servlet.ListUtil

Transposes and splits list into multiple lists of equal size.

trim(String) - Static method in class org.webmacro.servlet.TextTool

remove any leading and trailing whitespace from a string

trimBlock(String) - Static method in class org.webmacro.servlet.TextTool

remove the leading and trailing whitespace from each line in a block of text

type - Variable in class org.webmacro.directive.Directive.ArgDescriptor

U

UNDEFINED - Static variable in interface org.webmacro.parser.WMParser_implConstants

URLDecode(String) - Static method in class org.webmacro.servlet.TextTool

Decode a URLEncoded input String.

URLEncode(String) - Static method in class org.webmacro.servlet.TextTool

URLEncode the specified input String.

URLTemplate - class org.webmacro.resource.URLTemplate.

FileTemplate objects read their template data from a text file.

URLTemplate(Broker, URL) - Constructor for class org.webmacro.resource.URLTemplate

Instantiate a template based on the specified file.

URLTemplateLoader - class org.webmacro.URLTemplateLoader.

Implementation of TemplateLoader that loads templates from a given URL.

URLTemplateLoader() - Constructor for class org.webmacro.URLTemplateLoader

URLTemplateProvider - class org.webmacro.resource.URLTemplateProvider.

This is a "drop-in" replacement for the standard TemplateProvider in the WebMacro distribution.

URLTemplateProvider() - Constructor for class org.webmacro.resource.URLTemplateProvider

URLTool - class org.webmacro.servlet.URLTool.

Provide Template with access to url handing routines

URLTool() - Constructor for class org.webmacro.servlet.URLTool

URLTool.URLToolImpl - class org.webmacro.servlet.URLTool.URLToolImpl.

URLTool.URLToolImpl(WebContext) - Constructor for class org.webmacro.servlet.URLTool.URLToolImpl

UndefinedMacro - class org.webmacro.engine.UndefinedMacro.

Looks like a Macro, but really it's an undefined variable.

UnsettableException - exception org.webmacro.UnsettableException.

This exception is thrown on attempt to set something that is not settable.

UnsettableException(String) - Constructor for class org.webmacro.UnsettableException

Constructor only requires a reason

UrlProvider - class org.webmacro.resource.UrlProvider.

This is the canonical provider for mapping URLs to Handlers.

UrlProvider() - Constructor for class org.webmacro.resource.UrlProvider

update(LogTarget, String) - Method in class org.webmacro.util.LogSystem

LogTarget should call this method to notify LogSystem that conditions have changed and that the subscribe() method on LogTarget may now return a different value.

V

VERSION - Static variable in interface org.webmacro.WebMacro

The current version of WebMacro.

Variable - class org.webmacro.engine.Variable.

A Variable is a reference into a Propertymap.

VariableBuilder - class org.webmacro.engine.VariableBuilder.

VariableBuilder(Object[]) - Constructor for class org.webmacro.engine.VariableBuilder

VariableReference() - Method in class org.webmacro.parser.WMParser_impl

VariableReferenceGuts(ArrayList) - Method in class org.webmacro.parser.WMParser_impl

VariableTool - class org.webmacro.servlet.VariableTool.

A ContextTool which allows one to snoop information about an object in the active Context.

VariableTool() - Constructor for class org.webmacro.servlet.VariableTool

VariableTool(Context) - Constructor for class org.webmacro.servlet.VariableTool

Visitable - interface org.webmacro.Visitable.

Visitable Interface implemented by Macros so that Visitors can traverse them.

VoidMacro - class org.webmacro.engine.VoidMacro.

VoidMacro doesn't output data to the output stream, but will log a debug message (if debugging is turned on) when either of it's methods are called.

VoidMacro() - Constructor for class org.webmacro.engine.VoidMacro

valid - Variable in class org.webmacro.directive.DirectiveDescriptor

values() - Method in class org.webmacro.Context

Method from Map interface, operates on underlying Map

variableName - Variable in class org.webmacro.PropertyException.NoSuchMethodException

variableName - Variable in class org.webmacro.PropertyException.NoSuchVariableException

variableName - Variable in class org.webmacro.PropertyException.NullToStringException

variableName - Variable in class org.webmacro.PropertyException.NullValueException

visitBinaryOperation(String, Object, Object) - Method in class org.webmacro.TemplateVisitor

visitBinaryOperation(String, Object, Object) - Method in class org.webmacro.engine.TemplateDumper

visitDirectiveArg(String, Object) - Method in class org.webmacro.TemplateVisitor

visitDirectiveArg(String, Object) - Method in class org.webmacro.engine.TemplateDumper

visitMacro(Macro) - Method in class org.webmacro.TemplateVisitor

visitString(String) - Method in class org.webmacro.TemplateVisitor

visitString(String) - Method in class org.webmacro.engine.TemplateDumper

visitUnaryOperation(String, Object) - Method in class org.webmacro.TemplateVisitor

visitUnaryOperation(String, Object) - Method in class org.webmacro.engine.TemplateDumper

visitUnknownMacro(String, Macro) - Method in class org.webmacro.TemplateVisitor

visitUnknownMacro(String, Macro) - Method in class org.webmacro.engine.TemplateDumper

visitVariable(Variable, Object[]) - Method in class org.webmacro.TemplateVisitor

visitVariable(Variable, Object[]) - Method in class org.webmacro.engine.TemplateDumper

W

WARNING - Static variable in class org.webmacro.util.LogSystem

WEBMACRO_DEFAULTS - Static variable in class org.webmacro.Broker

WEBMACRO_DEFAULTS_FILE - Static variable in class org.webmacro.WMConstants

name of the default properties file

WEBMACRO_LOCAL_FILE - Static variable in class org.webmacro.WMConstants

name of the local properties file.

WEBMACRO_PROPERTIES - Static variable in class org.webmacro.Broker

WEBMACRO_PROPERTIES_FILE - Static variable in class org.webmacro.WMConstants

name of the properties file

WM - class org.webmacro.WM.

This class implements the WebMacro Manager interface.

WM() - Constructor for class org.webmacro.WM

Constructs a WM which gets its properties (optionally) from the file WebMacro.properties, as found on the class path.

WM(Properties) - Constructor for class org.webmacro.WM

Constructs a WM which gets its properties (optionally) from the file WebMacro.properties, as found on the class path, and from properties specified in a provided Properties.

WM(String) - Constructor for class org.webmacro.WM

Constructs a WM which gets its properties from the file specified, which must exist on the class path or be an absolute path.

WM(Servlet) - Constructor for class org.webmacro.WM

Constructs a WM is tied to a Servlet broker.

WM(Servlet, Properties) - Constructor for class org.webmacro.WM

Constructs a WM is tied to a Servlet broker, with an additional set of properties passed in from the caller.

WM(ServletContext, ClassLoader, Properties) - Constructor for class org.webmacro.WM

Constructs a WM is tied to a Servlet broker, with an additional set of properties passed in from the caller, using the ServletContext and ClassLoader provided.

WM(Broker) - Constructor for class org.webmacro.WM

Constructs a WM from an arbitrary Broker.

WM - Static variable in interface org.webmacro.parser.WMParser_implConstants

WMConstants - class org.webmacro.WMConstants.

WMConstants() - Constructor for class org.webmacro.WMConstants

WMContent(ParserBlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

WMContentNoDirective(ParserBlockBuilder) - Method in class org.webmacro.parser.WMParser_impl

WMDocument() - Method in class org.webmacro.parser.WMParser_impl

WMEval - class org.webmacro.util.WMEval.

WMEval encapsulates an instance of WebMacro for reuse in any java application.

WMEval(Servlet) - Constructor for class org.webmacro.util.WMEval

The constructor for WebMacro decorator in a servlet context.

WMEval() - Constructor for class org.webmacro.util.WMEval

WMParser - class org.webmacro.parser.WMParser.

WMParser(Broker) - Constructor for class org.webmacro.parser.WMParser

WMParser_impl - class org.webmacro.parser.WMParser_impl.

WMParser_impl JavaCC parser class for parsing WebMacro templates.

WMParser_impl(Broker, String, BackupCharStream) - Constructor for class org.webmacro.parser.WMParser_impl

WMParser_impl(Broker, String, Reader) - Constructor for class org.webmacro.parser.WMParser_impl

WMParser_impl(CharStream) - Constructor for class org.webmacro.parser.WMParser_impl

WMParser_impl(WMParser_implTokenManager) - Constructor for class org.webmacro.parser.WMParser_impl

WMParser_implConstants - interface org.webmacro.parser.WMParser_implConstants.

WMParser_implTokenManager - class org.webmacro.parser.WMParser_implTokenManager.

WMParser_implTokenManager(CharStream) - Constructor for class org.webmacro.parser.WMParser_implTokenManager

WMParser_implTokenManager(CharStream, int) - Constructor for class org.webmacro.parser.WMParser_implTokenManager

WMServlet - class org.webmacro.servlet.WMServlet.

This is an abstract base class which can be used to implement a kind of WebMacro servlet.

WMServlet() - Constructor for class org.webmacro.servlet.WMServlet

WMStringEval - class org.webmacro.util.WMStringEval.

A simple encapsulation of a WebMacro instance for evaluating string-based templates.

WMStringEval() - Constructor for class org.webmacro.util.WMStringEval

Constructs an WM String evaluator with a context.

WMTemplate - class org.webmacro.engine.WMTemplate.

Template objects represent the user defined layout into which the webmacro package will substitute values.

WMTemplate(Broker) - Constructor for class org.webmacro.engine.WMTemplate

Create a new Template.

WMTemplate(String, Broker) - Constructor for class org.webmacro.engine.WMTemplate

Create a new Template specifying both the broker and the parsing language.

WMTemplateAntTask - class org.webmacro.tools.WMTemplateAntTask.

Taskdef for validating WM templates

WMTemplateAntTask() - Constructor for class org.webmacro.tools.WMTemplateAntTask

WORD - Static variable in interface org.webmacro.parser.WMParser_implConstants

WS - Static variable in interface org.webmacro.parser.WMParser_implConstants

WebContext - class org.webmacro.servlet.WebContext.

This is an implementation of the WebContext interface.

WebContext(Broker, HttpServletRequest, HttpServletResponse) - Constructor for class org.webmacro.servlet.WebContext

Construct a new WebContext.

WebMacro - interface org.webmacro.WebMacro.

WebMacro Manager Interface This interface provies root access into the WebMacro system.

WebMacroException - exception org.webmacro.WebMacroException.

This is the base class of all WebMacro exceptions.

WebMacroException() - Constructor for class org.webmacro.WebMacroException

WebMacroException(String) - Constructor for class org.webmacro.WebMacroException

WebMacroException(String, Throwable) - Constructor for class org.webmacro.WebMacroException

WebMacroRuntimeException - exception org.webmacro.WebMacroRuntimeException.

This is the base class of all WebMacro runtime exceptions.

WebMacroRuntimeException() - Constructor for class org.webmacro.WebMacroRuntimeException

WebMacroRuntimeException(String) - Constructor for class org.webmacro.WebMacroRuntimeException

WebMacroRuntimeException(String, Throwable) - Constructor for class org.webmacro.WebMacroRuntimeException

WebMacroView - class org.webmacro.adapter.spring.WebMacroView.

Author: mpalmer

WebMacroView() - Constructor for class org.webmacro.adapter.spring.WebMacroView

WebMacroViewResolver - class org.webmacro.adapter.spring.WebMacroViewResolver.

User: mpalmer

WebMacroViewResolver() - Constructor for class org.webmacro.adapter.spring.WebMacroViewResolver

Word() - Method in class org.webmacro.parser.WMParser_impl

warning(String, Throwable) - Method in interface org.webmacro.Log

Warnings are messages outlining unexpected non-routine events within the system.

warning(String) - Method in interface org.webmacro.Log

A shortform for debug(msg,null)

warning(String, Throwable) - Method in class org.webmacro.util.LogSource

Warnings are messages outlining unexpected non-routine events within the system.

warning(String) - Method in class org.webmacro.util.LogSource

A shortform for warning(msg,null)

warningString(String) - Method in class org.webmacro.engine.CrankyEvaluationExceptionHandler

warningString(String) - Method in class org.webmacro.engine.DebugEvaluationExceptionHandler

warningString(String) - Method in class org.webmacro.engine.DefaultEvaluationExceptionHandler

warningString(String) - Method in interface org.webmacro.engine.EvaluationExceptionHandler

wm - Variable in class org.webmacro.servlet.TemplateServlet

The thread-safe evaluator of all templates.

write(char[]) - Method in class org.webmacro.FastWriter

Write characters to the output stream performing slow unicode conversion unless AsciiHack is on.

write(char[], int, int) - Method in class org.webmacro.FastWriter

Write characters to to the output stream performing slow unicode conversion.

write(int) - Method in class org.webmacro.FastWriter

Write a single character, performing slow unicode conversion

write(String) - Method in class org.webmacro.FastWriter

Write a string to the underlying output stream, performing unicode conversion.

write(String, int, int) - Method in class org.webmacro.FastWriter

write(byte[]) - Method in class org.webmacro.FastWriter

Write raw bytes to the underlying stream.

write(byte[], int, int) - Method in class org.webmacro.FastWriter

Write raw bytes to the underlying stream.

write(FastWriter, Context) - Method in interface org.webmacro.Macro

Interpret the directive and write it out, using the values in the supplied context as appropriate.

write(OutputStream, Context) - Method in interface org.webmacro.Template

write(OutputStream, String, Context) - Method in interface org.webmacro.Template

write(FastWriter, Context) - Method in interface org.webmacro.Template

write(FastWriter, Context) - Method in class org.webmacro.directive.AlternateDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.AttributeDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.BeanDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.CommentDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.CountDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.DefaultDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.DummyDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.EvalDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.ForeachDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.GlobalDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.IncludeDirective

Write out the included file to the specified FastWriter.

write(FastWriter, Context) - Method in class org.webmacro.directive.MacroDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.ParamDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.SetDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.SetblockDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.SetpropsDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.TempletDirective

Do nothing.

write(FastWriter, Context) - Method in class org.webmacro.directive.TextDirective

write(FastWriter, Context) - Method in class org.webmacro.directive.TypeDirective

The #type directive does not produce output

write(FastWriter, Context) - Method in class org.webmacro.engine.Block

Interpret the directive and write it out, using the values in the supplied context as appropriate.

write(FastWriter, Context) - Method in class org.webmacro.engine.Expression.ExpressionBase

write(FastWriter, Context) - Method in class org.webmacro.engine.MacroAdapter

Just calls toString() and writes that, context is ignored.

write(FastWriter, Context) - Method in class org.webmacro.engine.StringMacro

write(FastWriter, Context) - Method in class org.webmacro.engine.StringMacroAdapter

Just calls toString() and writes that, context is ignored.

write(FastWriter, Context) - Method in class org.webmacro.engine.UndefinedMacro

Throws an exception -- cannot write an undefined

write(FastWriter, Context) - Method in class org.webmacro.engine.Variable

Look in the hashtable (context) for a value keyed to this variables name and write its value to the stream.

write(FastWriter, Context) - Method in class org.webmacro.engine.VoidMacro

write(OutputStream, Context) - Method in class org.webmacro.engine.WMTemplate

write(OutputStream, String, Context) - Method in class org.webmacro.engine.WMTemplate

write(FastWriter, Context) - Method in class org.webmacro.engine.WMTemplate

write(int) - Method in class org.webmacro.util.ByteBufferOutputStream

write(byte[]) - Method in class org.webmacro.util.ByteBufferOutputStream

Copy an array of bytes on to the end of the buffer

write(byte[], int, int) - Method in class org.webmacro.util.ByteBufferOutputStream

Copy an array of bytes on to the end of the buffer

write(byte) - Method in class org.webmacro.util.ByteBufferOutputStream

Append a single byte

writeStatic(String) - Method in class org.webmacro.FastWriter

Write a string to the underlying output stream, performing unicode conversion if necessary--try and read the encoding from an encoding cache if possible.

writeTemplate(String, OutputStream, Context) - Method in class org.webmacro.WM

Convenience method for writing a template to an OutputStream.

writeTemplate(String, OutputStream, String, Context) - Method in class org.webmacro.WM

Convienence method for writing a template to an OutputStream.

writeTemplate(String, OutputStream, Context) - Method in interface org.webmacro.WebMacro

Convienence method for writing a template to an OutputStream.

writeTemplate(String, OutputStream, String, Context) - Method in interface org.webmacro.WebMacro

Convienence method for writing a template to an OutputStream.

writeTemplate(String, OutputStream, Context) - Method in class org.webmacro.servlet.WMServlet

Convenience method for writing a template to an OutputStream.

writeTemplate(String, OutputStream, String, Context) - Method in class org.webmacro.servlet.WMServlet

Convienence method for writing a template to an OutputStream.

writeTo(OutputStream) - Method in class org.webmacro.FastWriter

Copy the contents written so far to the suppiled output stream

writeTo(OutputStream) - Method in class org.webmacro.util.ByteBufferOutputStream

Write the bytes to the specified output stream

writeWarning(String, Context, FastWriter) - Static method in class org.webmacro.directive.Directive

Convenience method for directives to write HTML warnings into the output stream.

_

_ALPHANUM_CHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

_ALPHA_CHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

_COMMENT - Static variable in interface org.webmacro.parser.WMParser_implConstants

_IDENTIFIER - Static variable in interface org.webmacro.parser.WMParser_implConstants

_IDENTIFIER_CHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

_NEWLINE - Static variable in interface org.webmacro.parser.WMParser_implConstants

_NUM_CHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

_QCHAR - Static variable in interface org.webmacro.parser.WMParser_implConstants

_RESTOFLINE - Static variable in interface org.webmacro.parser.WMParser_implConstants

_WHITESPACE - Static variable in interface org.webmacro.parser.WMParser_implConstants

_args - Static variable in class org.webmacro.directive.TypeDirective

_broker - Variable in class org.webmacro.engine.WMTemplate

The resource broker used to resolve things in this template

_cacheSupportsReload - Variable in class org.webmacro.resource.CachingProvider

_columnNo - Variable in class org.webmacro.Context.TemplateEvaluationContext

_config - Variable in class org.webmacro.Broker

_content - Variable in class org.webmacro.engine.WMTemplate

What this template contains is a top level block

_dd - Static variable in class org.webmacro.directive.TypeDirective

_defaultFormatString - Variable in class org.webmacro.util.AbstractLogFile

_defaultLevel - Variable in class org.webmacro.util.AbstractLogFile

_directiveName - Variable in class org.webmacro.directive.IncludeDirective

the name given to the directive by webmacro configuration.

_formatString - Variable in class org.webmacro.util.AbstractLogFile

_getBroker(ServletContext, ClassLoader, Properties, boolean, String) - Static method in class org.webmacro.servlet.Servlet20Broker

Get an existing instance of the Servlet 2.0/2.1 broker or create a new one.

_hashCode - Variable in class org.webmacro.util.Encoder.Block

_levels - Variable in class org.webmacro.util.AbstractLogFile

_lineNo - Variable in class org.webmacro.Context.TemplateEvaluationContext

_log - Variable in class org.webmacro.Broker

_log - Variable in class org.webmacro.directive.IncludeDirective

Logging can be good

_log - Variable in class org.webmacro.engine.WMTemplate

Where we log our errors

_log - Variable in class org.webmacro.servlet.WMServlet

Log object used to write out messages

_ls - Variable in class org.webmacro.Broker

_macFilename - Variable in class org.webmacro.directive.IncludeDirective

the filename as a Macro, if the filename arg is a Macro

_mf - Variable in class org.webmacro.util.AbstractLogFile

_myClassLoader - Static variable in class org.webmacro.Broker

_name - Variable in class org.webmacro.Broker

_name - Variable in class org.webmacro.util.AbstractLogFile

_names - Variable in class org.webmacro.engine.Variable

The name as an array

_observers - Variable in class org.webmacro.util.AbstractLogFile

_propertyOperators - Variable in class org.webmacro.Broker

_providers - Variable in class org.webmacro.Broker

_servletClassLoader - Variable in class org.webmacro.servlet.Servlet20Broker

_servletClassLoader - Variable in class org.webmacro.servlet.Servlet22Broker

_servletContext - Variable in class org.webmacro.servlet.ServletBroker

_strFilename - Variable in class org.webmacro.directive.IncludeDirective

the filename as a String, if it is something we can determine during build()

_systemClassLoader - Static variable in class org.webmacro.Broker

_templateName - Variable in class org.webmacro.Context.TemplateEvaluationContext

_templatePrefix - Variable in class org.webmacro.servlet.Servlet22Broker

_trace - Variable in class org.webmacro.util.AbstractLogFile

_type - Variable in class org.webmacro.directive.IncludeDirective

the included file type.

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