Package com.codemesh.terp.api

The com.codemesh.terp.api package contains the public API that you are most likely to extend for custom additions to terp.

See:
Description

Interface Summary

Converter<T>	An interface implemented by all factory types that can create an object of one type from another object.
Executor<T>	The interface implemented by all executors that take 0 to n arguments.
Formatter	A formatter is a special kind of transformer with a CharSequence result type.
InternalContext	An interface implemented by all concrete internal scope contexts.
Lvalue	An lvalue that provides access to setting a value.
Named	The interface implemented by some named entities.
NodeTypes	Definitions for all the node types in the terp system.
Nvalue	An atomic value supporting pre/post increment/decrement operations or append operations.
Rvalue	A right-hand side value.
Scalar	The interface that signals that a particular transformer creates a scalar value from a collection.
Selector<T>	A filter that accepts or rejects items from a collection.
SelectorCallback	An interface used as a callback by selectors that need to delegate the selection determination to another entity, usually the collection to which the element belongs.
Sorter	An interface implemented by concrete sorters.
TemplateSource	An interface implemented by objects that can be used as a source of template lookups by name.
TerpConstants	An interface containing definitions that are useful for registering or unregistering operations.
TerpContext	The interface implemented by the concrete evaluation context.
TerpEvaluator	The interface implemented by the concrete terp evaluator.
TerpInitializer	A callback interface that can register/unregister extensions to the terp framework.
TerpRegistrar	The API for registering and unregistering terp extensions.
TerpSerializable	An interface implemented by types that know how to convert themselves into stringified terp expressions.
TokenTypes	Global definitions.
Transformer<T>	The interface used to transform an item into another item, for example in collection enumerators etc.

Class Summary

CharacterStream	The wrapper type for various input sources.
Executor.AbstractExecutor<T>	A convenient base class for your own custom executors.
Executor.ForMethod
FeedbackManager	The type responsible for conveying feedback to the user.
Formatter.AbstractFormatter	The baseclass for all concrete formatters.
Formatter.Base64
Formatter.Capitalize	A formatter that uppercases the first N (default 1) characters.
Formatter.Namefy	A formatter that trims and replaces non-alphabetic characters with a configurable character sequence (default is the underscore).
Formatter.Pad	A formatter that pads an item with a configurable string to a configurable width, before or after the item.
Formatter.Remove	A formatter that removes a string from an item.
Formatter.Replace	A formatter that replaces a substring with another.
Formatter.TextFormatter	A formatter that applies a Java format string with optional arguments to the item.
Formatter.ToAscii	A formatter that .
Formatter.ToLowercase	A formatter that converts a string to its lowercase representation.
Formatter.ToSlug	A formatter that converts a string with spaces and underscores to a lowercase string with dashes.
Formatter.ToUppercase	A formatter that converts a string to its uppercase representation.
Formatter.ToXml	A formatter that converts a string to an XML includable representation.
InputSource	Wrapper for the input into a parser.
Lvalue.AbstractLvalue
Lvalue.FieldInvoker
Lvalue.ForMap	A value getter for a string map.
Lvalue.MethodInvoker
Node	AST node for the terp language.
Nvalue.AbstractNvalue
Range	An object that maintains two numeric bounds.
Rvalue.AbstractRvalue
Rvalue.FieldInvoker
Rvalue.ForMap	A value getter for a string map.
Rvalue.Holder
Rvalue.MethodInvoker
Rvalue.PropertyHolder<T>	A hoder type that can be used to provide a level of indirection for collections.
Scalar.AbstractScalarTransformer<T>
Scalar.Concatenate
Selector.AbstractSelector<T>	A baseclass for concrete selectors.
Sorter.AbstractSorter	An abstract baseclass for concrete sorters.
Token	A token in the terp grammar.
Transformer.AbstractTransformer<T>
Transformer.LineBreaker

Enum Summary

Justify	Justfication values for text expansions.
TokenizerState	The supported tokenizer states.

Exception Summary

TerpException	The base class of all exceptions thrown by the terp interpreter.
ValidationException	The baseclasee of all excpetions that are thrown when a terp data item doe not validate.

Annotation Types Summary

TerpDataType	Marker interface that flags a built-in terp datatype.
TerpHelp	An annotation containing help for a terp item.

Package com.codemesh.terp.api Description

The com.codemesh.terp.api package contains the public API that you are most likely to extend for custom additions to terp. This package consists mostly of interface types, but there are a few classes as well.