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

A

addMacro(String, String) - Method in class com.ccg.macros.AtMacros

Add a simple string subsitution macro.

addMacro(String, MacroHandler) - Method in class com.ccg.macros.AtMacros

Associate a MacroHandler with a macro name.

addMacros(Object) - Method in class com.ccg.macros.AtMacros

Add all "macro handling methods" from a class to our defined set.

All - Class in com.ccg.macros.at

A simple command line utility that can be used to test all Base classes in the package.

All(String[]) - Constructor for class com.ccg.macros.at.All

Initializes object with a set of command line arguments.

At - Class in com.ccg.macros

A command line implementation of "@macros".

At(String[]) - Constructor for class com.ccg.macros.At

Initializes object with an array of command line arguments.

atCopyFile(Output, Vector) - Method in class com.ccg.macros.at.Script

@atCopyFile(SRC,DST) copy AND interpret one file to another.

atCopyToDir(Output, Vector) - Method in class com.ccg.macros.At

@atCopyToDir(MATCH0,MATCH1,&02e;&02e;&02e;,DIR) copy AND interpret one or more files to directory.

atCopyToDir(Output, Vector) - Method in class com.ccg.macros.at.Script

@atCopyToDir(MATCH0,MATCH1,...,DIR) copy AND interpret one or more files to directory.

AtMacros - Class in com.ccg.macros

Implementation of a "@macro" Interpreter.

AtMacros() - Constructor for class com.ccg.macros.AtMacros

Initializes object to the default parsing rules.

AtMacros(AtMacros) - Constructor for class com.ccg.macros.AtMacros

A copy constructor of another AtMacros object.

B

Base - Class in com.ccg.macros.at

Base class for specialized @macro handlers.

Base(boolean) - Constructor for class com.ccg.macros.at.Base

Construct the object and optionally interpret a initialization file.

C

changeCase(Output, Vector) - Method in class com.ccg.macros.at.Strings

@changeCase(TEXT,MODE) - change the case of TEXT to uppercase, lowercase or mixed case.

clear() - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

close() - Method in class com.ccg.macros.InputReader

close() - Method in class com.ccg.macros.OutputWriter

com.ccg.macros - package com.ccg.macros

Text Macro Processing Classes..

com.ccg.macros.at - package com.ccg.macros.at

At Macro Definitions..

copyFile(Output, Vector) - Method in class com.ccg.macros.at.Script

@copyFile(SRC,DST) copy one file to another.

copyToDir(Output, Vector) - Method in class com.ccg.macros.At

@copyToDir(MATCH0,MATCH1,&02e;&02e;&02e;,DIR) copy one or more files to directory.

copyToDir(Output, Vector) - Method in class com.ccg.macros.at.Script

@copyToDir(MATCH0,MATCH1,...,DIR) copy one or more files to directory.

Core - Class in com.ccg.macros.at

Set of core macros which provide some standard basic features.

Core() - Constructor for class com.ccg.macros.at.Core

Constructs the object and readies it for installation.

createAtMacros() - Static method in class com.ccg.macros.at.All

Create a new AtMacros object and install all standard macros.

D

debug(Output, Vector) - Method in class com.ccg.macros.at.Core

@debug(LEVEL,TEXT) macro - debug output.

decrement(Output, Vector) - Method in class com.ccg.macros.at.Core

@decrement(NAME) decrements value of integer macro by 1.

define(Output, Vector) - Method in class com.ccg.macros.at.Core

@define(NAME,VAL[,OPT]) macro - define a new macro.

define(Output, Vector) - Method in class com.ccg.macros.At

@define(NAME,VAL[,OPT]) macro - define a new macro.

definition(Output, Vector) - Method in class com.ccg.macros.at.Core

@definition(NAME) macro - fetch definition of a macro.

definition(Output, Vector) - Method in class com.ccg.macros.At

@definition(NAME) macro - fetch definition of a macro.

dumpDefinitions(Output, Vector) - Method in class com.ccg.macros.at.Core

@dumpDefinitions() macro - dump definition of all macros.

dumpDefinitions(Output, Vector) - Method in class com.ccg.macros.At

@dumpDefinitions() macro - dump definition of all macros.

E

encodeFormParam(Output, Vector) - Method in class com.ccg.macros.at.Html

@encodeFormParam(TEXT) - escape paramters passed as form values in a URL string.

F

flush() - Method in class com.ccg.macros.OutputWriter

fnb(Output, Vector) - Method in class com.ccg.macros.at.Core

@fnb(V0[,V1[,V2[,...]) macro - find first "non-blank" value.

formatMillis(Output, Vector) - Method in class com.ccg.macros.at.Core

@formatMillis([MILLIS][,DATE_FMT[,TIME_FMT]],[TZ]) macro - format a Java millisecond count.

G

getAtMacros() - Method in class com.ccg.macros.at.Base

Get the associated AtMacros processor.

getAtMacros() - Method in class com.ccg.macros.At

Get the "@macro" interpreter to use.

getBuffer() - Method in class com.ccg.macros.Input

getBuffer() - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

getDepth() - Method in class com.ccg.macros.AtMacros

Get the current depth of the recursion as we are processing

getDoubleParameter(Vector, int, double) - Method in class com.ccg.macros.at.Base

Safely retrieve and interpret a parameter and get the double value.

getEndParamChar() - Method in class com.ccg.macros.AtMacros

Get the symbol which indicates the end of the parameter list

getEndQuoteChar() - Method in class com.ccg.macros.AtMacros

Get the symbol which ends a "quoted" string

getEscapeChar() - Method in class com.ccg.macros.AtMacros

Get the "escape" character which can appear in quoted strings

getInstance() - Static method in class com.ccg.macros.OutputNull

Reference to the single global null output device.

getIntParameter(Vector, int, int) - Method in class com.ccg.macros.at.Base

Safely retrieve and interpret a parameter and get the integer value.

getLength() - Method in class com.ccg.macros.Input

getLineSeparator() - Method in class com.ccg.macros.at.Core

Get the string used to separate lines on the current platform

getLineSeparator() - Method in class com.ccg.macros.At

Get the string used to separate lines on the current platform.

getLongParameter(Vector, int, long) - Method in class com.ccg.macros.at.Base

Safely retrieve and interpret a parameter and get the integer value.

getMacro(String) - Method in class com.ccg.macros.AtMacros

Fetch the object definition for a particular macro.

getMacroNames() - Method in class com.ccg.macros.AtMacros

Fetch the list of all macro names which are currently defined.

getOffset() - Method in class com.ccg.macros.Input

getParameter(int, boolean) - Method in class com.ccg.macros.AtMacros

Fetch one of the parameters (arguments) passed to a macro.

getParameter(int) - Method in class com.ccg.macros.AtMacros

Fetch one of the parameters (arguments) passed to a macro.

getRecursionDepth() - Method in class com.ccg.macros.AtMacros

Get the number of recursive calls allowed while evalutating

getSepParamChar() - Method in class com.ccg.macros.AtMacros

Get the character used to separate parameters in a parameter list

getStartMacroChar() - Method in class com.ccg.macros.AtMacros

Get the symbol which indicates the start of a macro

getStartParamChar() - Method in class com.ccg.macros.AtMacros

Get the symbol which indicates the start of the parameter list

getStartQuoteChar() - Method in class com.ccg.macros.AtMacros

Get the symbol which starts a "quoted" string

getStringParameter(Vector, int) - Method in class com.ccg.macros.at.Base

Safely retrieve and interpret a parameter.

H

Html - Class in com.ccg.macros.at

Macros related to the generation of HTML documents.

Html() - Constructor for class com.ccg.macros.at.Html

Constructs the object and readies it for installation.

htmlEscape(Output, Vector) - Method in class com.ccg.macros.at.Html

@htmlEscape(TEXT) - escape special HTML characters '<', '>' and '&'.

htmlEscape(Output, Vector) - Method in class com.ccg.macros.At

@htmlEscape(TEXT) - escape special HTML characters '<', '>' and '&'.

I

ifDefined(Output, Vector) - Method in class com.ccg.macros.at.Core

@ifDefined(MACRO,YES,NO) macro - branch if macro is defined.

ifEqual(Output, Vector) - Method in class com.ccg.macros.at.Core

@ifEqual(V1,V2,E,NE) macro - branching macro.

ifFileExists(Output, Vector) - Method in class com.ccg.macros.at.Script

@ifFileExists(NAME,IF_EXISTS,IF_NOT) determine if file exists.

include(Output, Vector) - Method in class com.ccg.macros.at.Core

@include(SOURCE,[IGNERR],[NOOUT]) insert and process other file(s).

include(Output, Vector) - Method in class com.ccg.macros.At

@include(SOURCE,[IGNERR],[NOOUT]) insert and process other file(s).

increment(Output, Vector) - Method in class com.ccg.macros.at.Core

@increment(NAME) increments value of integer macro by 1.

indexOf(Output, Vector) - Method in class com.ccg.macros.at.Strings

@indexOf(TEXT,SEARCH_IN) - searches for index of text string in larger string.

Input - Class in com.ccg.macros

Describe...

Input() - Constructor for class com.ccg.macros.Input

Input(String) - Constructor for class com.ccg.macros.Input

Input(char[], int, int) - Constructor for class com.ccg.macros.Input

InputReader - Class in com.ccg.macros

Describe...

InputReader() - Constructor for class com.ccg.macros.InputReader

Initializes object to...

InputReader(Reader) - Constructor for class com.ccg.macros.InputReader

InputReader(File) - Constructor for class com.ccg.macros.InputReader

InputReader(InputStream) - Constructor for class com.ccg.macros.InputReader

install(AtMacros) - Method in class com.ccg.macros.at.Base

Register's all of the method macros AND loads the predefined property macros for the class.

installAll(AtMacros) - Static method in class com.ccg.macros.at.All

Global static method to install ALL of the macro handler objects available in this package.

interpret(Input, Output) - Method in class com.ccg.macros.AtMacros

Process a input source and write the results to a output destination.

interpret(String) - Method in class com.ccg.macros.AtMacros

Process a source string and return the resulting string.

interpret(Input, Output) - Method in interface com.ccg.macros.Interpreter

The fundamental method which ALL interpreters must implement.

interpretCheck(String) - Method in class com.ccg.macros.AtMacros

Process a source string and return the resulting string.

interpretCheck(Input, Output) - Method in class com.ccg.macros.AtMacros

Process a input source and write the results to a output destination.

Interpreter - Interface in com.ccg.macros

This interface should be implemented by all macro processors.

InterpretException - Exception in com.ccg.macros

Base exception class for errors which occur while processing macros.

InterpretException() - Constructor for exception com.ccg.macros.InterpretException

Default constructor (message not set).

InterpretException(String) - Constructor for exception com.ccg.macros.InterpretException

Construct with initial message.

J

javaEscape(Output, Vector) - Method in class com.ccg.macros.at.Strings

@javaEscape(TEXT) - create a Java "escape" string from a source string.

javaUnescape(Output, Vector) - Method in class com.ccg.macros.at.Strings

@javaUnescape(TEXT) - takes a "escaped" Java string and outputs the "unescaped" values.

L

loadDefaultDefinitions() - Method in class com.ccg.macros.At

Process a set of well known user files.

loadTSV(Output, Vector) - Method in class com.ccg.macros.At

@loadTSV(NAME,SOURCE) load a tab separated table.

loadTSV(Output, Vector) - Method in class com.ccg.macros.at.Script

@loadTSV(NAME,SOURCE) load a tab separated table.

M

MacroHandler - Interface in com.ccg.macros

Describe...

MacroHandlerMethod - Class in com.ccg.macros

MacroHandlerMethod(Object, Method) - Constructor for class com.ccg.macros.MacroHandlerMethod

main(String[]) - Static method in class com.ccg.macros.at.All

Main entry point into the application.

main(String[]) - Static method in class com.ccg.macros.at.Html

Main entry point into the application.

N

now(Output, Vector) - Method in class com.ccg.macros.At

@now() macro - dumps current time.

O

Output - Interface in com.ccg.macros

Interface defining what to do with text generated from output.

OutputNull - Class in com.ccg.macros

A "null" output device for interpreter output.

OutputNull() - Constructor for class com.ccg.macros.OutputNull

OutputStringBuffer - Class in com.ccg.macros

A Output implementation which uses a string buffer.

OutputStringBuffer() - Constructor for class com.ccg.macros.OutputStringBuffer

Construct a output string buffer with the default initial capacity.

OutputStringBuffer(int) - Constructor for class com.ccg.macros.OutputStringBuffer

Construct a output string buffer with a initial capacity.

OutputStringBuffer(StringBuffer) - Constructor for class com.ccg.macros.OutputStringBuffer

Construct a output buffer with a existing buffer.

OutputStringBuffer(String) - Constructor for class com.ccg.macros.OutputStringBuffer

Construct a output buffer with some initial content.

OutputWriter - Class in com.ccg.macros

Describe...

OutputWriter(Writer) - Constructor for class com.ccg.macros.OutputWriter

Create a Output object which uses a Writer to write the results of interpretation to.

OutputWriter(OutputStream) - Constructor for class com.ccg.macros.OutputWriter

Create a Output object which uses a OutputStream to write the results of interpretation to.

OutputWriter(File) - Constructor for class com.ccg.macros.OutputWriter

P

param(Output, Vector) - Method in class com.ccg.macros.at.Core

@param(N[,t|f]) macro - get parameter value This macro is typically used in the definition of run time macros (in the VAL parameter of "@define(NAME,VAL)".

param(Output, Vector) - Method in class com.ccg.macros.At

@param(N) macro - get parameter value.

parseParams(Input) - Method in class com.ccg.macros.AtMacros

process(Output, Vector) - Method in class com.ccg.macros.at.TableField

process(Output, Vector) - Method in class com.ccg.macros.at.TableInsert

process(Output, Vector) - Method in interface com.ccg.macros.MacroHandler

One line summary...

process(Output, Vector) - Method in class com.ccg.macros.MacroHandlerMethod

process(Output, Vector) - Method in class com.ccg.macros.TableField

process(Output, Vector) - Method in class com.ccg.macros.TableInsert

processData() - Method in class com.ccg.macros.at.TableInsert

processData() - Method in class com.ccg.macros.TableInsert

Q

quote(Output, Vector) - Method in class com.ccg.macros.at.Core

@quote(TEXT) macro - output text verbatim This macro is invoked in the form "@quote(TEXT)".

quote(Output, Vector) - Method in class com.ccg.macros.At

@quote(TEXT) macro - output text verbatim.

R

replaceChar(Output, Vector) - Method in class com.ccg.macros.at.Strings

@replaceChar(TEXT,OLDCHAR,NEWCHAR) - replace all occurances of one character with another.

run() - Method in class com.ccg.macros.at.All

Runs the macro processor.

run() - Method in class com.ccg.macros.At

Runs the interpreter reading from the input source and writing the output.

S

Script - Class in com.ccg.macros.at

@macros useful for "script" style processing.

Script() - Constructor for class com.ccg.macros.at.Script

Constructs the object and readies it for installation.

setAtMacros(AtMacros) - Method in class com.ccg.macros.At

Set the "@macro" interpreter to use.

setBuffer(StringBuffer) - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

setBuffer(int) - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

setBuffer(String) - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

setDepth(int) - Method in class com.ccg.macros.AtMacros

Set the current depth of the recursion as we are processing

setDocumentInfo(Output, Vector) - Method in class com.ccg.macros.at.Core

@setDocumentInfo(TYPE,INFO,yyyy-MM-dd) set information about the document.

setEndMacroChar(char, boolean) - Method in class com.ccg.macros.AtMacros

Set/clear individual character which indicates end of macro name.

setEndMacroChars(String) - Method in class com.ccg.macros.AtMacros

Set the symbol(s) which indicate the end of a macro name

setEndParamChar(char) - Method in class com.ccg.macros.AtMacros

Set the symbol which indicates the end of the parameter list

setEndQuoteChar(char) - Method in class com.ccg.macros.AtMacros

Set the symbol which ends a "quoted" string

setEscapeChar(char) - Method in class com.ccg.macros.AtMacros

Set the "escape" character which can appear in quoted strings

setLength(int) - Method in class com.ccg.macros.Input

setLineSeparator(String) - Method in class com.ccg.macros.at.Core

Set the string used to separate lines on the current platform

setLineSeparator(String) - Method in class com.ccg.macros.At

Set the string used to separate lines on the current platform.

setOffset(int) - Method in class com.ccg.macros.Input

setRecursionDepth(int) - Method in class com.ccg.macros.AtMacros

Set the number of recursive calls allowed while evalutating Typically one doesn't need to worry about setting a recursion depth limit (the default value should be sufficient in most cases).

setSepParamChar(char) - Method in class com.ccg.macros.AtMacros

Set the character used to separate parameters in a parameter list

setStartMacroChar(char) - Method in class com.ccg.macros.AtMacros

Set the symbol which indicates the start of a macro

setStartParamChar(char) - Method in class com.ccg.macros.AtMacros

Set the symbol which indicates the start of the parameter list

setStartQuoteChar(char) - Method in class com.ccg.macros.AtMacros

Set the symbol which starts a "quoted" string

shiftAndFill(int) - Method in class com.ccg.macros.Input

shiftAndFill(int) - Method in class com.ccg.macros.InputReader

Strings - Class in com.ccg.macros.at

General purpose "String" related macros.

Strings() - Constructor for class com.ccg.macros.at.Strings

Constructs the object and readies it for installation.

systemProperty(Output, Vector) - Method in class com.ccg.macros.at.Core

@systemProperty(NAME[,DEF]) macro - fetch a specific system property.

T

TableField - Class in com.ccg.macros.at

TableField(AtMacros, String, TableInsert) - Constructor for class com.ccg.macros.at.TableField

TableField - Class in com.ccg.macros

TableField(AtMacros, String, TableInsert) - Constructor for class com.ccg.macros.TableField

TableInsert - Class in com.ccg.macros.at

TableInsert(AtMacros, String, String) - Constructor for class com.ccg.macros.at.TableInsert

TableInsert - Class in com.ccg.macros

TableInsert(AtMacros, String, String) - Constructor for class com.ccg.macros.TableInsert

tableRow(Output, Vector) - Method in class com.ccg.macros.at.Html

@tableRow(COL0,COL1,...) generate single row in HTML table.

toOsFileName(Output, Vector) - Method in class com.ccg.macros.at.Strings

@toOsFileName(TEXT) - replace '/' or '\' characters in file names according to the OS preference.

toString() - Method in class com.ccg.macros.MacroHandlerMethod

toString() - Method in class com.ccg.macros.OutputStringBuffer

One line summary...

U

urlJoin(Output, Vector) - Method in class com.ccg.macros.at.Html

@urlJoin(ROOT[,SUB0[,SUB1 ...]) - do a "smart" join of strings when forming URL(s).

W

write(char[], int, int) - Method in interface com.ccg.macros.Output

Writes a set of characters from a buffer to the output.

write(Object) - Method in interface com.ccg.macros.Output

Outputs the string representation of a Object.

write(char[], int, int) - Method in class com.ccg.macros.OutputNull

Writes a set of characters from a buffer to the output.

write(Object) - Method in class com.ccg.macros.OutputNull

Outputs the string representation of a Object.

write(char[], int, int) - Method in class com.ccg.macros.OutputStringBuffer

Writes a set of characters from a buffer to the output.

write(Object) - Method in class com.ccg.macros.OutputStringBuffer

Appends the string representation of a Object to the output.

write(char[], int, int) - Method in class com.ccg.macros.OutputWriter

Writes a set of characters from a buffer to the output.

write(Object) - Method in class com.ccg.macros.OutputWriter

Outputs the string representation of a Object.

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