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

A

accept(TokenType...) - Method in class au.com.codeka.carrot.expr.Tokenizer
Returns true if the current token is and of the given TokenTypes.
accept(int, TokenType) - Method in class au.com.codeka.carrot.expr.Tokenizer
Returns true if the token at the given offset from the current is of the given TokenType.
add(String, Class<? extends Tag>) - Method in class au.com.codeka.carrot.TagRegistry
 
add(TagRegistry.TagMatcher, Class<? extends Tag>) - Method in class au.com.codeka.carrot.TagRegistry
 
add(Node) - Method in class au.com.codeka.carrot.tmpl.Node
Add the given Node to our list of children.
add(Object, Object) - Static method in class au.com.codeka.carrot.ValueHelper
Adds the two values together.
addAndCond(AndCond) - Method in class au.com.codeka.carrot.expr.NotCond.Builder
 
addFactor(Token, Factor) - Method in class au.com.codeka.carrot.expr.Term.Builder
 
addNode(ResourceName, Node) - Method in class au.com.codeka.carrot.ParseCache
 
addOrCond(OrCond) - Method in class au.com.codeka.carrot.expr.AndCond.Builder
 
addParam(Expression) - Method in class au.com.codeka.carrot.expr.Function.Builder
Add the given Expression as an argument to the function.
addTerm(Token, Term) - Method in class au.com.codeka.carrot.expr.Comparator.Builder
 
AndCond - Class in au.com.codeka.carrot.expr
An "andcond".
AndCond.Builder - Class in au.com.codeka.carrot.expr
 
au.com.codeka.carrot - package au.com.codeka.carrot
 
au.com.codeka.carrot.expr - package au.com.codeka.carrot.expr
 
au.com.codeka.carrot.helpers - package au.com.codeka.carrot.helpers
 
au.com.codeka.carrot.resource - package au.com.codeka.carrot.resource
 
au.com.codeka.carrot.tag - package au.com.codeka.carrot.tag
 
au.com.codeka.carrot.tmpl - package au.com.codeka.carrot.tmpl
 
au.com.codeka.carrot.tmpl.parse - package au.com.codeka.carrot.tmpl.parse
 
au.com.codeka.carrot.util - package au.com.codeka.carrot.util
 

B

BlockTag - Class in au.com.codeka.carrot.tag
The {% block %} tag is used in conjunction with {% extends %}.
BlockTag() - Constructor for class au.com.codeka.carrot.tag.BlockTag
 
build() - Method in class au.com.codeka.carrot.expr.AndCond.Builder
 
build() - Method in class au.com.codeka.carrot.expr.Comparator.Builder
 
build() - Method in class au.com.codeka.carrot.expr.Function.Builder
 
build() - Method in class au.com.codeka.carrot.expr.NotCond.Builder
 
build() - Method in class au.com.codeka.carrot.expr.Term.Builder
 
Builder(OrCond) - Constructor for class au.com.codeka.carrot.expr.AndCond.Builder
 
Builder(Token, Term) - Constructor for class au.com.codeka.carrot.expr.Comparator.Builder
 
Builder(Identifier) - Constructor for class au.com.codeka.carrot.expr.Function.Builder
Construct a new Function.Builder for a function with the given Identifier as it's name.
Builder(AndCond) - Constructor for class au.com.codeka.carrot.expr.NotCond.Builder
 
Builder(Token, Factor) - Constructor for class au.com.codeka.carrot.expr.Term.Builder
 

C

canChain(Tag) - Method in class au.com.codeka.carrot.tag.ElseTag
Return true if we can chain to the given next Tag.
canChain(Tag) - Method in class au.com.codeka.carrot.tag.ForTag
Return true if we can chain to the given next Tag.
canChain(Tag) - Method in class au.com.codeka.carrot.tag.IfTag
Return true if we can chain to the given next Tag.
canChain(Tag) - Method in class au.com.codeka.carrot.tag.Tag
Return true if we can chain to the given next Tag.
canChain(Node) - Method in class au.com.codeka.carrot.tmpl.Node
Checks whether this Node can chain to the given node.
canChain(Node) - Method in class au.com.codeka.carrot.tmpl.TagNode
 
CarrotEngine - Class in au.com.codeka.carrot
CarrotEngine is the root of the carrot system.
CarrotEngine() - Constructor for class au.com.codeka.carrot.CarrotEngine
Constructs a new CarrotEngine with a default Configuration.
CarrotEngine(Configuration) - Constructor for class au.com.codeka.carrot.CarrotEngine
Constructs a new CarrotEngine with the given Configuration.
CarrotException - Exception in au.com.codeka.carrot
All exceptions thrown by carrot are subclasses of this exception.
CarrotException(String) - Constructor for exception au.com.codeka.carrot.CarrotException
 
CarrotException(Exception) - Constructor for exception au.com.codeka.carrot.CarrotException
 
CarrotException(Exception, ResourcePointer) - Constructor for exception au.com.codeka.carrot.CarrotException
 
CarrotException(String, Exception) - Constructor for exception au.com.codeka.carrot.CarrotException
 
CarrotException(String, ResourcePointer) - Constructor for exception au.com.codeka.carrot.CarrotException
 
chain(Node) - Method in class au.com.codeka.carrot.tmpl.Node
Chain to the given next Node.
checkNotNull(Object) - Static method in class au.com.codeka.carrot.util.Preconditions
 
checkState(boolean) - Static method in class au.com.codeka.carrot.util.Preconditions
 
Comparator - Class in au.com.codeka.carrot.expr
An Comparator is of the form: expression = ["+"|"-"] term {("+"|"-") term}
Comparator.Builder - Class in au.com.codeka.carrot.expr
 
Configuration - Class in au.com.codeka.carrot
The Configuration is used to configure various aspects of the carrot engine.
Configuration() - Constructor for class au.com.codeka.carrot.Configuration
 
Configuration.Logger - Interface in au.com.codeka.carrot
 
create(Token) - Static method in class au.com.codeka.carrot.tmpl.FixedNode
 
create(TokenType, String) - Static method in class au.com.codeka.carrot.tmpl.parse.Token
Create a new Token.
create(TokenType, String, ResourcePointer) - Static method in class au.com.codeka.carrot.tmpl.parse.Token
Create a new Token.
create(TokenType, StringBuilder) - Method in interface au.com.codeka.carrot.tmpl.parse.TokenFactory
 
create(Token, Configuration) - Static method in class au.com.codeka.carrot.tmpl.TagNode
Creates a TagNode for the given Token.
createEcho(Token, Configuration) - Static method in class au.com.codeka.carrot.tmpl.TagNode
Creates a special TagNode for an echo token.
createTag(String) - Method in class au.com.codeka.carrot.TagRegistry
 

D

debug(Configuration, String, Object...) - Static method in class au.com.codeka.carrot.util.Log
 
divide(Object, Object) - Static method in class au.com.codeka.carrot.ValueHelper
Divides the left hand side by the right hand side, and returns the result.

E

EchoTag - Class in au.com.codeka.carrot.tag
Echo tag just echos the results of it's single parameter.
EchoTag() - Constructor for class au.com.codeka.carrot.tag.EchoTag
 
ElseTag - Class in au.com.codeka.carrot.tag
The ElseTag can be chained with IfTag or ForTag to contain the "else" block.
ElseTag() - Constructor for class au.com.codeka.carrot.tag.ElseTag
 
end() - Method in class au.com.codeka.carrot.expr.Tokenizer
 
EndTag - Class in au.com.codeka.carrot.tag
The "end" tag, for all tags that end blocks.
EndTag() - Constructor for class au.com.codeka.carrot.tag.EndTag
 
equals(Object) - Method in class au.com.codeka.carrot.expr.Token
 
equals(Object) - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
escape(String) - Method in class au.com.codeka.carrot.helpers.HtmlHelper
Escape the HTML.
escape(SafeString) - Method in class au.com.codeka.carrot.helpers.HtmlHelper
Escape the HTML.
escape(Object) - Static method in class au.com.codeka.carrot.ValueHelper
Performs HTML-escaping of the given value.
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.AndCond
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Comparator
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Expression
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Factor
 
evaluate(Object, Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Function
Evaluate this function on the given object, with the given Configuration and Scope.
evaluate() - Method in class au.com.codeka.carrot.expr.Identifier
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.NotCond
 
evaluate() - Method in class au.com.codeka.carrot.expr.NumberLiteral
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.OrCond
 
evaluate() - Method in class au.com.codeka.carrot.expr.StringLiteral
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Term
 
evaluate(Configuration, Scope) - Method in class au.com.codeka.carrot.expr.Variable
 
expect(TokenType...) - Method in class au.com.codeka.carrot.expr.Tokenizer
Returns a Token if it's one of the given types, or throws a CarrotException if it's not.
Expression - Class in au.com.codeka.carrot.expr
An expression.
Expression(boolean, NotCond) - Constructor for class au.com.codeka.carrot.expr.Expression
 
ExtendsTag - Class in au.com.codeka.carrot.tag
The "extends" tag is used to base one template off of another one.
ExtendsTag() - Constructor for class au.com.codeka.carrot.tag.ExtendsTag
 

F

Factor - Class in au.com.codeka.carrot.expr
A Factor is either variable, identifier, string literal, number literal or an expression surrounded by brackets.
Factor(Variable) - Constructor for class au.com.codeka.carrot.expr.Factor
 
Factor(NumberLiteral) - Constructor for class au.com.codeka.carrot.expr.Factor
 
Factor(StringLiteral) - Constructor for class au.com.codeka.carrot.expr.Factor
 
Factor(Expression) - Constructor for class au.com.codeka.carrot.expr.Factor
 
FileResourceLocater - Class in au.com.codeka.carrot.resource
An implementation of ResourceLocater that loads files from the file system.
FileResourceLocater(Configuration, String) - Constructor for class au.com.codeka.carrot.resource.FileResourceLocater
Constructs a new FileResourceLocater using the given Configuration and base path to search for resources in.
findResource(ResourceName, String) - Method in class au.com.codeka.carrot.resource.FileResourceLocater
 
findResource(String) - Method in class au.com.codeka.carrot.resource.FileResourceLocater
 
findResource(ResourceName, String) - Method in class au.com.codeka.carrot.resource.MemoryResourceLocator
 
findResource(String) - Method in class au.com.codeka.carrot.resource.MemoryResourceLocator
 
findResource(ResourceName, String) - Method in interface au.com.codeka.carrot.resource.ResourceLocater
Searches for a resource with the given name, returns the full path to it.
findResource(String) - Method in interface au.com.codeka.carrot.resource.ResourceLocater
Searches for a resource with the given name, returns the full path to it.
FixedNode - Class in au.com.codeka.carrot.tmpl
A FixedNode represents the text outside of the {% ...
ForTag - Class in au.com.codeka.carrot.tag
The "for" tag iterates through a loop and execute it's black for each element0.
ForTag() - Constructor for class au.com.codeka.carrot.tag.ForTag
 
Function - Class in au.com.codeka.carrot.expr
A function identifier and a list of arguments to that function.
Function.Builder - Class in au.com.codeka.carrot.expr
Simple builder class for Function.

G

getAutoEscape() - Method in class au.com.codeka.carrot.Configuration
 
getBlockName(CarrotEngine, Scope) - Method in class au.com.codeka.carrot.tag.BlockTag
 
getChildren() - Method in class au.com.codeka.carrot.tmpl.Node
 
getConfig() - Method in class au.com.codeka.carrot.CarrotEngine
 
getContent() - Method in class au.com.codeka.carrot.tmpl.FixedNode
 
getContent() - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
getEncoding() - Method in class au.com.codeka.carrot.Configuration
 
getGlobalBindings() - Method in class au.com.codeka.carrot.CarrotEngine
 
getLineNo() - Method in class au.com.codeka.carrot.resource.ResourcePointer
 
getLogger() - Method in class au.com.codeka.carrot.Configuration
 
getModifiedTime(ResourceName) - Method in class au.com.codeka.carrot.resource.FileResourceLocater
 
getModifiedTime(ResourceName) - Method in class au.com.codeka.carrot.resource.MemoryResourceLocator
 
getModifiedTime(ResourceName) - Method in interface au.com.codeka.carrot.resource.ResourceLocater
Gets a value which indicates when the resource was modified.
getName() - Method in class au.com.codeka.carrot.resource.ResourceName
 
getNextNode() - Method in class au.com.codeka.carrot.tmpl.Node
 
getNextToken() - Method in class au.com.codeka.carrot.tmpl.parse.Tokenizer
Gets the next token from the stream, or null if there's no tokens left.
getNode(ResourceName) - Method in class au.com.codeka.carrot.ParseCache
 
getParent() - Method in class au.com.codeka.carrot.resource.ResourceName
 
getPointer() - Method in exception au.com.codeka.carrot.CarrotException
 
getPointer() - Method in class au.com.codeka.carrot.tmpl.Node
 
getPointer() - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
getPointer() - Method in class au.com.codeka.carrot.tmpl.parse.Tokenizer
 
getPointer() - Method in class au.com.codeka.carrot.util.LineReader
 
getReader(ResourceName) - Method in class au.com.codeka.carrot.resource.FileResourceLocater
 
getReader(ResourceName) - Method in class au.com.codeka.carrot.resource.MemoryResourceLocator
 
getReader(ResourceName) - Method in interface au.com.codeka.carrot.resource.ResourceLocater
Gets a Reader to read the contents of the given resource.
getResourceLocater() - Method in class au.com.codeka.carrot.Configuration
 
getTag() - Method in class au.com.codeka.carrot.tmpl.TagNode
 
getTagRegistry() - Method in class au.com.codeka.carrot.Configuration
 
getType() - Method in class au.com.codeka.carrot.expr.Token
 
getType() - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
getValue() - Method in class au.com.codeka.carrot.expr.NumberLiteral
 
getValue() - Method in class au.com.codeka.carrot.expr.StringLiteral
 
getValue() - Method in class au.com.codeka.carrot.expr.Token
 

H

hashCode() - Method in class au.com.codeka.carrot.expr.Token
 
hashCode() - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
hasValue() - Method in enum au.com.codeka.carrot.expr.TokenType
 
HtmlHelper - Class in au.com.codeka.carrot.helpers
Registered in the global Scope as "html", contains a bunch of functions you can call from your script related to HTML and HTML processing.
HtmlHelper() - Constructor for class au.com.codeka.carrot.helpers.HtmlHelper
 

I

Identifier - Class in au.com.codeka.carrot.expr
An Identifier.
Identifier(Token) - Constructor for class au.com.codeka.carrot.expr.Identifier
 
IfTag - Class in au.com.codeka.carrot.tag
The "if" tag evaluates it's single parameter and outputs it's children if true.
IfTag() - Constructor for class au.com.codeka.carrot.tag.IfTag
 
info(Configuration, String, Object...) - Static method in class au.com.codeka.carrot.util.Log
 
isBlockNode() - Method in class au.com.codeka.carrot.tmpl.Node
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.BlockTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.ElseTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.ExtendsTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.ForTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.IfTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.SetTag
 
isBlockTag() - Method in class au.com.codeka.carrot.tag.Tag
 
isEndBlock() - Method in class au.com.codeka.carrot.tmpl.TagNode
 
isMatch(String) - Method in interface au.com.codeka.carrot.TagRegistry.TagMatcher
 
isTrue(Object) - Static method in class au.com.codeka.carrot.ValueHelper
Does the given value represent "true".
iterate(Object) - Static method in class au.com.codeka.carrot.ValueHelper
Convert the given value to a list of object, as if it were an iterable.

L

LEVEL_DEBUG - Static variable in interface au.com.codeka.carrot.Configuration.Logger
 
LEVEL_INFO - Static variable in interface au.com.codeka.carrot.Configuration.Logger
 
LEVEL_WARNING - Static variable in interface au.com.codeka.carrot.Configuration.Logger
 
LineReader - Class in au.com.codeka.carrot.util
A helper class that reads a Reader one line at a time, keeping track of the current line and colume via a ResourcePointer.
LineReader(ResourceName, Reader) - Constructor for class au.com.codeka.carrot.util.LineReader
 
LineReader(ResourcePointer, Reader) - Constructor for class au.com.codeka.carrot.util.LineReader
 
Log - Class in au.com.codeka.carrot.util
Helper for writing to the configured logger.
Log() - Constructor for class au.com.codeka.carrot.util.Log
 

M

maybeParseIdentifier() - Method in class au.com.codeka.carrot.expr.StatementParser
Tries to parse an identifier from the stream and returns it if we parsed it, otherwise returns null.
MemoryResourceLocator - Class in au.com.codeka.carrot.resource
A simple ResourceLocater that just keeps stuff in memory.
MemoryResourceLocator(Map<String, String>) - Constructor for class au.com.codeka.carrot.resource.MemoryResourceLocator
Constructs a new MemoryResourceLocator using the given Configuration and base path to search for resources in.
multiply(Object, Object) - Static method in class au.com.codeka.carrot.ValueHelper
Multiplies the left hand side by the right hand side, and returns the result.

N

name - Variable in class au.com.codeka.carrot.resource.ResourceName
 
negate(Object) - Static method in class au.com.codeka.carrot.ValueHelper
Returns the "negative" of the given value.
nextChar() - Method in class au.com.codeka.carrot.util.LineReader
 
nextCol() - Method in class au.com.codeka.carrot.resource.ResourcePointer
 
nextLine(String) - Method in class au.com.codeka.carrot.resource.ResourcePointer
 
Node - Class in au.com.codeka.carrot.tmpl
Base class for nodes in the abstract syntax tree.
Node(ResourcePointer, boolean) - Constructor for class au.com.codeka.carrot.tmpl.Node
 
NotCond - Class in au.com.codeka.carrot.expr
An "notcond" node.
NotCond.Builder - Class in au.com.codeka.carrot.expr
 
NumberLiteral - Class in au.com.codeka.carrot.expr
A number (integer or double).
NumberLiteral(Token) - Constructor for class au.com.codeka.carrot.expr.NumberLiteral
 

O

OrCond - Class in au.com.codeka.carrot.expr
An "orcond".
OrCond(Comparator) - Constructor for class au.com.codeka.carrot.expr.OrCond
 
OrCond(Comparator, Token, Comparator) - Constructor for class au.com.codeka.carrot.expr.OrCond
 

P

parent - Variable in class au.com.codeka.carrot.resource.ResourceName
 
parse(Tokenizer) - Method in class au.com.codeka.carrot.tmpl.TemplateParser
 
ParseCache - Class in au.com.codeka.carrot
Helper class used to cache parsed template files.
ParseCache(Configuration) - Constructor for class au.com.codeka.carrot.ParseCache
 
parseEnd() - Method in class au.com.codeka.carrot.expr.StatementParser
Parses the "end" of the statement.
parseExpression() - Method in class au.com.codeka.carrot.expr.StatementParser
 
parseIdentifier() - Method in class au.com.codeka.carrot.expr.StatementParser
 
parseNumber() - Method in class au.com.codeka.carrot.expr.StatementParser
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.BlockTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.EchoTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.ElseTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.ExtendsTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.ForTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.IfTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.SetTag
 
parseStatement(StatementParser) - Method in class au.com.codeka.carrot.tag.Tag
Parse the statement that appears after the tag in the markup.
parseString() - Method in class au.com.codeka.carrot.expr.StatementParser
 
peek() - Method in class au.com.codeka.carrot.Scope
 
pop() - Method in class au.com.codeka.carrot.Scope
Pop the most recent bindings off the stack.
Preconditions - Class in au.com.codeka.carrot.util
Similar to Guava's Preconditions class, just a bunch of helper methods for asserting our preconditions.
Preconditions() - Constructor for class au.com.codeka.carrot.util.Preconditions
 
print(int, String) - Method in interface au.com.codeka.carrot.Configuration.Logger
 
process(Writer, ResourceName, Scope) - Method in class au.com.codeka.carrot.CarrotEngine
Process the template with the given filename, writing the results to the given Writer.
process(Writer, String, Map<String, Object>) - Method in class au.com.codeka.carrot.CarrotEngine
Process the template with the given filename, writing the results to the given Writer.
process(String, Map<String, Object>) - Method in class au.com.codeka.carrot.CarrotEngine
Process the template with the given filename, and returns the result as a string.
push(Map<String, Object>) - Method in class au.com.codeka.carrot.Scope
Push the given bindings onto the stack.

R

render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.BlockTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.EchoTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.ElseTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.ExtendsTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.ForTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.IfTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.SetTag
 
render(CarrotEngine, Writer, TagNode, Scope) - Method in class au.com.codeka.carrot.tag.Tag
Render this Tag to the given Writer.
render(CarrotEngine, Writer, Scope) - Method in class au.com.codeka.carrot.tmpl.FixedNode
 
render(CarrotEngine, Writer, Scope) - Method in class au.com.codeka.carrot.tmpl.Node
Render this node to the given Writer.
render(CarrotEngine, Writer, Scope) - Method in class au.com.codeka.carrot.tmpl.RootNode
 
render(CarrotEngine, Writer, Scope) - Method in class au.com.codeka.carrot.tmpl.TagNode
 
renderChildren(CarrotEngine, Writer, Scope) - Method in class au.com.codeka.carrot.tmpl.Node
Render all of this Node's children to the given Writer.
resolve(String) - Method in class au.com.codeka.carrot.Scope
Resolve the given named variable from the stack of bindings, most recently-pushed to last.
ResourceLocater - Interface in au.com.codeka.carrot.resource
Used to resolve resource names to actual files.
ResourceName - Class in au.com.codeka.carrot.resource
The "name" of a resolved resource (usually a file, but not nessecarily).
ResourceName(ResourceName, String) - Constructor for class au.com.codeka.carrot.resource.ResourceName
 
ResourcePointer - Class in au.com.codeka.carrot.resource
Represents a "pointer" into a resource, useful for debugging and so on (for example, for displaying the line number and column where there's an error).
ResourcePointer(ResourceName) - Constructor for class au.com.codeka.carrot.resource.ResourcePointer
 
ResourcePointer(ResourceName, String, int, int) - Constructor for class au.com.codeka.carrot.resource.ResourcePointer
 
RootNode - Class in au.com.codeka.carrot.tmpl
Special node that represents the root of the syntax tree.
RootNode(ResourcePointer) - Constructor for class au.com.codeka.carrot.tmpl.RootNode
 

S

safe(String) - Method in class au.com.codeka.carrot.helpers.HtmlHelper
Mark the given string as "safe" for direct outputting.
SafeString - Class in au.com.codeka.carrot.util
This is a wrapper class for strings that we know are "safe" to output withing HTML-escaping.
SafeString(String) - Constructor for class au.com.codeka.carrot.util.SafeString
 
Scope - Class in au.com.codeka.carrot
Scope is a collection of all the bindings that are active.
Scope(Map<String, Object>) - Constructor for class au.com.codeka.carrot.Scope
Create a new Scope, with the given initial set of "global" bindings.
setAutoEscape(boolean) - Method in class au.com.codeka.carrot.Configuration
Sets whether or not you want to automatically escape all variable output.
setEncoding(String) - Method in class au.com.codeka.carrot.Configuration
 
setLogger(Configuration.Logger) - Method in class au.com.codeka.carrot.Configuration
 
setResourceLocater(ResourceLocater) - Method in class au.com.codeka.carrot.Configuration
 
SetTag - Class in au.com.codeka.carrot.tag
Set tag allows you to set the value a variable in the current scope to the string value of the contents of the set block.
SetTag() - Constructor for class au.com.codeka.carrot.tag.SetTag
 
StatementParser - Class in au.com.codeka.carrot.expr
StatementParser is used to parse expressions.
StatementParser(Tokenizer) - Constructor for class au.com.codeka.carrot.expr.StatementParser
 
StringLiteral - Class in au.com.codeka.carrot.expr
A string literal.
StringLiteral(Token) - Constructor for class au.com.codeka.carrot.expr.StringLiteral
 

T

Tag - Class in au.com.codeka.carrot.tag
Interface that tags must implement.
Tag() - Constructor for class au.com.codeka.carrot.tag.Tag
 
TagNode - Class in au.com.codeka.carrot.tmpl
A TagNode represents a node of the form "{% tagname foo %}" where "tagname" is the name of the tag and "foo" is the parameters.
TagNode(ResourcePointer, Tag) - Constructor for class au.com.codeka.carrot.tmpl.TagNode
 
TagRegistry - Class in au.com.codeka.carrot
Contains a collection of tags that will be matched when parsing a template.
TagRegistry(Configuration) - Constructor for class au.com.codeka.carrot.TagRegistry
 
TagRegistry.TagMatcher - Interface in au.com.codeka.carrot
Interface to implement for custom tag matching.
TemplateParser - Class in au.com.codeka.carrot.tmpl
Parses a stream of Tokens into a tree of Nodes.
TemplateParser(Configuration) - Constructor for class au.com.codeka.carrot.tmpl.TemplateParser
 
Term - Class in au.com.codeka.carrot.expr
A Term is of the form: term = factor {("*" | "/") factor}
Term.Builder - Class in au.com.codeka.carrot.expr
 
Token - Class in au.com.codeka.carrot.expr
A Token is something pulled off the statement stream and represents a terminal like a string literal, number, identifier, etc.
Token(TokenType) - Constructor for class au.com.codeka.carrot.expr.Token
 
Token(TokenType, Object) - Constructor for class au.com.codeka.carrot.expr.Token
 
Token - Class in au.com.codeka.carrot.tmpl.parse
Represents a token in a stream of tokens from the Tokenizer.
TokenFactory - Interface in au.com.codeka.carrot.tmpl.parse
Factory for creating Tokens.
Tokenizer - Class in au.com.codeka.carrot.expr
Converts an input Reader into a stream of Tokens.
Tokenizer(LineReader) - Constructor for class au.com.codeka.carrot.expr.Tokenizer
 
Tokenizer - Class in au.com.codeka.carrot.tmpl.parse
The Tokenizer takes an input stream of character and turns it into a stream of Tokens.
Tokenizer(LineReader) - Constructor for class au.com.codeka.carrot.tmpl.parse.Tokenizer
Construct a new Tokenizer with the given LineReader, and a default TokenFactory.
Tokenizer(LineReader, TokenFactory) - Constructor for class au.com.codeka.carrot.tmpl.parse.Tokenizer
Construct a new Tokenizer with the given LineReader and TokenFactory.
TokenType - Enum in au.com.codeka.carrot.expr
An enumeration of the different types of Tokens we can pull off the statement parser.
TokenType - Enum in au.com.codeka.carrot.tmpl.parse
An enumeration which describes the different types of tokens we can parse.
toNumber(Object) - Static method in class au.com.codeka.carrot.ValueHelper
Converts the given value to a Number.
toString() - Method in class au.com.codeka.carrot.expr.AndCond
 
toString() - Method in class au.com.codeka.carrot.expr.Comparator
Returns a string representation of this Comparator, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.Expression
 
toString() - Method in class au.com.codeka.carrot.expr.Factor
Returns a string representation of this Term, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.Function
 
toString() - Method in class au.com.codeka.carrot.expr.Identifier
Returns a string representation of this Identifier, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.NotCond
 
toString() - Method in class au.com.codeka.carrot.expr.NumberLiteral
Returns a string representation of this NumberLiteral, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.OrCond
 
toString() - Method in class au.com.codeka.carrot.expr.StringLiteral
Returns a string representation of this StringLiteral, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.Term
Returns a string representation of this Term, useful for debugging.
toString() - Method in class au.com.codeka.carrot.expr.Token
 
toString() - Method in class au.com.codeka.carrot.expr.Variable
Gets a string representation of the Variable, useful for debugging.
toString() - Method in class au.com.codeka.carrot.resource.ResourcePointer
 
toString() - Method in class au.com.codeka.carrot.tmpl.parse.Token
 
toString() - Method in class au.com.codeka.carrot.util.SafeString
 

U

unexpected(String) - Method in class au.com.codeka.carrot.expr.Tokenizer
Creates a CarrotException with the given message, populated with our current state.

V

ValueHelper - Class in au.com.codeka.carrot
Various helpers for working with Objects.
ValueHelper() - Constructor for class au.com.codeka.carrot.ValueHelper
 
valueOf(String) - Static method in enum au.com.codeka.carrot.expr.TokenType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.com.codeka.carrot.tmpl.parse.TokenType
Returns the enum constant of this type with the specified name.
values() - Static method in enum au.com.codeka.carrot.expr.TokenType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.com.codeka.carrot.tmpl.parse.TokenType
Returns an array containing the constants of this enum type, in the order they are declared.
Variable - Class in au.com.codeka.carrot.expr
A Variable is has the following EBNF form: variable = identifier ["." variable | "[" expression "]"] See StatementParser for the full grammar.
Variable(Identifier, Function, Expression, Variable) - Constructor for class au.com.codeka.carrot.expr.Variable
 

W

warning(Configuration, String, Object...) - Static method in class au.com.codeka.carrot.util.Log
 
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links