Index (CZT Session 1.6-SNAPSHOT API)

A C D E F G H I K L M N P R S T U V

A

AbstractCommand - Class in net.sourceforge.czt.session: Command superclass that respects the section manager's tracing protocols.
AbstractCommand() - Constructor for class net.sourceforge.czt.session.AbstractCommand
addCZTPathFor(File, SectionManager) - Static method in class net.sourceforge.czt.session.SourceLocator
assertCurrentTransaction(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager: Checks that the top of transaction stack (the current transaction) is the given key - throws an exception otherwise.
assertNewTransaction(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager: Checks that there are no existing transaction for the given key (thus the transaction is new) - throws and exception otherwise.
assertNotCached(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager: Checks that the given key is not cached in the section manager - throws an exception otherwise.
assertNoTransactions(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager: Checks that there are no transactions at all - throws an exception otherwise.

C

calculateDefaultParents(String) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: High level method used by the command computation chain to calculate the default parents of a given section name.
cancelTransaction(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Cancels the ongoing transaction in the section manager.
cancelTransaction(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
clone() - Method in class net.sourceforge.czt.session.SectionManager: Returns a new SectionManager with the same content, commands, and properties.
Command - Interface in net.sourceforge.czt.session: The command interface provides a method for computing objects.
CommandException - Exception in net.sourceforge.czt.session: An exception that is thrown when the execution of a Command fails.
CommandException(Dialect) - Constructor for exception net.sourceforge.czt.session.CommandException
CommandException(Dialect, String) - Constructor for exception net.sourceforge.czt.session.CommandException
CommandException(Dialect, String, Throwable) - Constructor for exception net.sourceforge.czt.session.CommandException
CommandException(Dialect, Throwable) - Constructor for exception net.sourceforge.czt.session.CommandException
compute(String, SectionManager) - Method in class net.sourceforge.czt.session.AbstractCommand: Performs the commands computation of the required resource within the section manager known to this command.
compute(String, SectionManager) - Method in interface net.sourceforge.czt.session.Command
content_ - Variable in class net.sourceforge.czt.session.SectionManager: The Cache storing computed values (e.g.

D

DEFAULT_EXTENSION - Static variable in class net.sourceforge.czt.session.SectionManager
DEFAULT_LOGLEVEL - Static variable in class net.sourceforge.czt.session.SectionManager
DEFAULT_TRACELEVEL - Static variable in class net.sourceforge.czt.session.SectionManager
DEFAULT_TRACING - Static variable in class net.sourceforge.czt.session.SectionManager
defaultParents(String) - Method in interface net.sourceforge.czt.session.DefaultSectionParents
defaultParents(String) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: Returns the default set of parents for a given section name for this dialect.
DefaultSectionParents - Interface in net.sourceforge.czt.session
DefaultSectionParentsCommand - Class in net.sourceforge.czt.session
DefaultSectionParentsCommand() - Constructor for class net.sourceforge.czt.session.DefaultSectionParentsCommand
dependants_ - Variable in class net.sourceforge.czt.session.SectionManager: Mapping of relationships from (LHS) Key to the set of other (RHS) keys that depend on it.
dependencies_ - Variable in class net.sourceforge.czt.session.SectionManager: Mapping of relationships from (LHS) Key to the set of other (RHS) keys that it depends on.
Dialect - Enum in net.sourceforge.czt.session
doCalculateDefaultAnonymousParents(Set<String>) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: Delegates calculation of parents for Section.ANONYMOUS sections, collecting the results in the parameter.
doCalculateDefaultParents(String, Set<String>) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: Delegates calculation of parents for named sections, collecting the results in the parameter.
doCompute(String, SectionManager) - Method in class net.sourceforge.czt.session.AbstractCommand
doCompute(String, SectionManager) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: Computes the calculation for default section parents for the given section name and stores in the section manager.
doCompute(String, SectionManager) - Method in class net.sourceforge.czt.session.SourceLocator: Tries to locate the resource named for the given section manager.

E

endTransaction(Key<T>, T, Collection<? extends Key<?>>) - Method in interface net.sourceforge.czt.session.SectionInfo: Ends the transaction for the given key and associates the computed value to this key in the section manager cache.
endTransaction(Key<T>, T) - Method in interface net.sourceforge.czt.session.SectionInfo: This is a convenience method for SectionInfo.endTransaction(Key, Object, Collection), with no explicit dependencies.
endTransaction(Key<T>, T) - Method in class net.sourceforge.czt.session.SectionManager
endTransaction(Key<T>, T, Collection<? extends Key<?>>) - Method in class net.sourceforge.czt.session.SectionManager
ensureTransaction(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Ensures that the indicated transaction is active in the section manager.
ensureTransaction(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
equals(Object) - Method in class net.sourceforge.czt.session.Key
EXTRA_TRACELEVEL - Static variable in class net.sourceforge.czt.session.SectionManager
extractPath(String) - Static method in class net.sourceforge.czt.session.SourceLocator: For a file "./dir/foo.ext" or ".\dir\foo.ext", extracts the path such that the result is "./dir/".

F

FileSource - Class in net.sourceforge.czt.session: Source from a file.
FileSource(String) - Constructor for class net.sourceforge.czt.session.FileSource
FileSource(File) - Constructor for class net.sourceforge.czt.session.FileSource

G

get(Key<T>) - Method in interface net.sourceforge.czt.session.SectionInfo: Looks up and resolves the key in the section manager.
get(Key<T>) - Method in class net.sourceforge.czt.session.SectionManager: Lookup a key in the section manager.
get(Class<T>) - Method in class net.sourceforge.czt.session.Session
get(String, Class<T>) - Method in class net.sourceforge.czt.session.Session
getAllErrorSufixes() - Static method in enum net.sourceforge.czt.session.Markup
getAllSufixes() - Static method in enum net.sourceforge.czt.session.Markup
getBooleanProperty(String) - Method in class net.sourceforge.czt.session.SectionManager
getCommand(Class<?>) - Method in class net.sourceforge.czt.session.SectionManager: Returns the command for calculating the given type of information.
getCommandKeys() - Method in class net.sourceforge.czt.session.SectionManager
getCurrentTransaction() - Method in interface net.sourceforge.czt.session.SectionInfo: Retrieves the currently active transaction.
getCurrentTransaction() - Method in class net.sourceforge.czt.session.SectionManager
getCZTPathFor(File, SectionManager) - Static method in class net.sourceforge.czt.session.SourceLocator
getDefaultEncoding(Markup) - Static method in enum net.sourceforge.czt.session.Markup
getDefaultFileExtention(Markup) - Static method in enum net.sourceforge.czt.session.Markup
getDependants(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Retrieves keys of all elements that depend on the given key.
getDependants(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
getDependencies(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Retrieves keys of all elements, that the given key depends on.
getDependencies(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
getDialect() - Method in exception net.sourceforge.czt.session.CommandException
getDialect() - Method in interface net.sourceforge.czt.session.DefaultSectionParents
getDialect() - Method in interface net.sourceforge.czt.session.SectionInfo: Returns the current language extension dialect is being managed (see Dialect).
getDialect() - Method in class net.sourceforge.czt.session.SectionManager
getEncoding() - Method in class net.sourceforge.czt.session.Source
getFileNameNoExt(String) - Static method in class net.sourceforge.czt.session.SourceLocator: For a file "./dir/foo.ext", returns "./dir/foo".
getIntegerProperty(String) - Method in class net.sourceforge.czt.session.SectionManager
getKnownLatexSuffixes() - Static method in enum net.sourceforge.czt.session.Markup
getKnownUnicodeSuffixes() - Static method in enum net.sourceforge.czt.session.Markup
getKnownXMLSuffixes() - Static method in enum net.sourceforge.czt.session.Markup
getListProperty(String) - Method in class net.sourceforge.czt.session.SectionManager
getLogger() - Method in class net.sourceforge.czt.session.SectionManager
getManager() - Method in class net.sourceforge.czt.session.Session
getMarkup(String) - Static method in enum net.sourceforge.czt.session.Markup
getMarkup() - Method in class net.sourceforge.czt.session.Source
getName() - Method in class net.sourceforge.czt.session.Key
getName() - Method in class net.sourceforge.czt.session.Source
getName() - Method in exception net.sourceforge.czt.session.SourceLocator.SourceLocatorException
getPath() - Method in exception net.sourceforge.czt.session.SourceLocator.SourceLocatorException
getProperties() - Method in class net.sourceforge.czt.session.SectionManager: Returns all the current property settings.
getProperty(String) - Method in class net.sourceforge.czt.session.SectionManager: Returns a property.
getReader() - Method in class net.sourceforge.czt.session.Source
getReader() - Method in class net.sourceforge.czt.session.StringSource
getSection() - Method in class net.sourceforge.czt.session.Session
getSourceName(String) - Static method in class net.sourceforge.czt.session.SourceLocator: Get the CZT Source name from a given file.
getStream() - Method in class net.sourceforge.czt.session.FileSource
getStream() - Method in class net.sourceforge.czt.session.Source
getStream() - Method in class net.sourceforge.czt.session.StdInSource
getStream() - Method in class net.sourceforge.czt.session.StringSource
getStream() - Method in class net.sourceforge.czt.session.UrlSource
getTracingLevel() - Method in interface net.sourceforge.czt.session.SectionInfo: Get current section manager tracing level as set by SectionInfo.setTracing(boolean, Level).
getTracingLevel() - Method in class net.sourceforge.czt.session.SectionManager
getType() - Method in class net.sourceforge.czt.session.Key
guessSettings(String) - Method in class net.sourceforge.czt.session.Source: Tries to guess markup and encoding based on the given string, which is usually the file or url name.

H

hashCode() - Method in class net.sourceforge.czt.session.Key
hasProperty(String) - Method in class net.sourceforge.czt.session.SectionManager
hasTransaction() - Method in class net.sourceforge.czt.session.SectionManager

I

isCached(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Checks whether the given key is cached within the section information manager
isCached(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager: Returns whether the given Key has already been computed and is cached.
isExtensionOf(Dialect) - Method in enum net.sourceforge.czt.session.Dialect
isPermanentKey(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
isTracing() - Method in interface net.sourceforge.czt.session.SectionInfo: Returns whether debugging tracing is on or not as set by SectionInfo.setTracing(boolean, Level).
isTracing() - Method in class net.sourceforge.czt.session.SectionManager

K

Key<T> - Class in net.sourceforge.czt.session: A Key is a pair (String,Class).
Key(String, Class<T>) - Constructor for class net.sourceforge.czt.session.Key
keysOf(String) - Method in interface net.sourceforge.czt.session.SectionInfo: Retrieve all the keys involving a given name (e.g., ZSect, Spec, Source, etc for given string name)
keysOf(Class<T>) - Method in interface net.sourceforge.czt.session.SectionInfo: Retrieve all the keys involving a given class type
keysOf(String) - Method in class net.sourceforge.czt.session.SectionManager
keysOf(Class<T>) - Method in class net.sourceforge.czt.session.SectionManager
knownDialectsAsStringArray() - Static method in enum net.sourceforge.czt.session.Dialect
KnownExtensions - Enum in net.sourceforge.czt.session
knownToolkits() - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand: Each dialect has a set of known toolkits.
knownToolkits(String) - Method in class net.sourceforge.czt.session.DefaultSectionParentsCommand

L

locateToolkit(String) - Method in class net.sourceforge.czt.session.SourceLocator: Locates the given name as a toolkit within CZT.jar /lib/name.tex
locateToolkitForClass(Class<?>, String) - Method in class net.sourceforge.czt.session.SourceLocator

M

Markup - Enum in net.sourceforge.czt.session: An enumeration of supported mark-ups.

N

net.sourceforge.czt.session - package net.sourceforge.czt.session: Provides classes for managing and caching Z sections, operator tables and other Z-related artifacts.
newerThan(TimeStamp) - Method in class net.sourceforge.czt.session.TimeStamp: True iff this entry was created after the other entry.

P

pendingDeps_ - Variable in class net.sourceforge.czt.session.SectionManager: The list of pending implicit dependencies, collected via the SectionManager.get(Key) calls.
postponeTransaction(Key<?>, Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Postpones the just-started transaction to ensure a correct transaction order.
postponeTransaction(Key<?>, Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
processCZTPaths(String) - Static method in class net.sourceforge.czt.session.SourceLocator: Very simple path splitting through path.split(File.pathSeparator).
processProperties(SectionManager) - Method in class net.sourceforge.czt.session.AbstractCommand: Pass section manager to enable derived classes to preprocess any property of interest
PROP_CZT_PATH - Static variable in class net.sourceforge.czt.session.SourceLocator
put(Key<T>, T, Collection<? extends Key<?>>) - Method in interface net.sourceforge.czt.session.SectionInfo: Adds the value to the section manager cache.
put(Key<T>, T) - Method in interface net.sourceforge.czt.session.SectionInfo: This is a convenience method for SectionInfo.put(Key, Object, Collection), with no explicit dependencies.
put(Key<T>, T) - Method in class net.sourceforge.czt.session.SectionManager
put(Key<T>, T, Collection<? extends Key<?>>) - Method in class net.sourceforge.czt.session.SectionManager
putCommand(String, String) - Method in class net.sourceforge.czt.session.SectionManager: Add a new command for calculating information of a given type.
putCommand(Class<?>, Command) - Method in class net.sourceforge.czt.session.SectionManager: Add a new command for calculating information, overriding any existing commands used for calculating this type of information.
putCommands(Dialect) - Method in class net.sourceforge.czt.session.SectionManager: Adds the default commands for the given Z extension/dialect.
putCommands(URL) - Method in class net.sourceforge.czt.session.SectionManager: Loads a collection of commands from the given properties file/url.
putCommands(Properties) - Method in class net.sourceforge.czt.session.SectionManager: Adds a set of default commands from a Properties object.
putCommands(Dialect) - Method in class net.sourceforge.czt.session.Session

R

registerDefaultPermanentKeys() - Method in class net.sourceforge.czt.session.SectionManager
registerPermanentKey(String) - Method in class net.sourceforge.czt.session.SectionManager
removeKey(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Removes the key and its value from the section manager cache.
removeKey(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
removePath(String) - Static method in class net.sourceforge.czt.session.SourceLocator: For a file "./dir/foo.ext" or ".\dir\foo.ext", removes the path such that the result is "foo.ext".
removePermanentKey(String) - Method in class net.sourceforge.czt.session.SectionManager
reset() - Method in interface net.sourceforge.czt.session.SectionInfo: Resets the section manager.
reset() - Method in class net.sourceforge.czt.session.SectionManager
retrieveCZTProperties(Dialect) - Static method in class net.sourceforge.czt.session.SourceLocator: Retrieve the czt.properties file within user.dir or "."
retrieveKey(T) - Method in interface net.sourceforge.czt.session.SectionInfo: Returns whether the given value has already been computed and is cached.
retrieveKey(T) - Method in class net.sourceforge.czt.session.SectionManager: Returns whether the given value has already been computed and is cached.

S

SECTION_MANAGER_LIST_PROPERTY_SEPARATOR - Static variable in class net.sourceforge.czt.session.SectionManager
SectionInfo - Interface in net.sourceforge.czt.session: A section information (also called section manager) is the central place for storage and computation of CZT information.
SectionInfoException - Exception in net.sourceforge.czt.session
SectionInfoException() - Constructor for exception net.sourceforge.czt.session.SectionInfoException: Constructs a new CZT exception with null as its message.
SectionInfoException(String) - Constructor for exception net.sourceforge.czt.session.SectionInfoException: Constructs a new CZT exception with the specified message.
SectionInfoException(String, Throwable) - Constructor for exception net.sourceforge.czt.session.SectionInfoException: Constructs a new CZT exception with the specified message and cause.
SectionInfoException(Throwable) - Constructor for exception net.sourceforge.czt.session.SectionInfoException: Constructs a new CZT exception with the specified cause.
SectionManager - Class in net.sourceforge.czt.session: This class is a repository for information about (Z) specs/sections (and its extensions).
SectionManager(Dialect) - Constructor for class net.sourceforge.czt.session.SectionManager: Creates a new section manager for a given Z extension/dialect.
SectionManager(Dialect, boolean, Level, Level) - Constructor for class net.sourceforge.czt.session.SectionManager
Session - Class in net.sourceforge.czt.session: A session contains a section manager and records the name of the current section.
Session(Dialect) - Constructor for class net.sourceforge.czt.session.Session
setEncoding(String) - Method in class net.sourceforge.czt.session.Source
setMarkup(Markup) - Method in class net.sourceforge.czt.session.Source
setName(String) - Method in class net.sourceforge.czt.session.Source
setPath(String) - Method in class net.sourceforge.czt.session.Session
setProperties(Properties) - Method in class net.sourceforge.czt.session.SectionManager: Sets a whole bunch of properties to the given values.
setProperty(String, String) - Method in class net.sourceforge.czt.session.SectionManager: Sets a property to the given value.
setSection(String) - Method in class net.sourceforge.czt.session.Session
setTracing(boolean, Level) - Method in interface net.sourceforge.czt.session.SectionInfo: Set section management tracing on/off.
setTracing(boolean, Level) - Method in class net.sourceforge.czt.session.SectionManager: Set section management tracing on/off.
setTracing(boolean) - Method in class net.sourceforge.czt.session.SectionManager
setTracing(boolean, Handler, Level) - Method in class net.sourceforge.czt.session.SectionManager
Source - Class in net.sourceforge.czt.session: The source of a specification.
Source() - Constructor for class net.sourceforge.czt.session.Source
SourceLocator - Class in net.sourceforge.czt.session: A command to compute the URL for a Z section.
SourceLocator() - Constructor for class net.sourceforge.czt.session.SourceLocator
SourceLocator.SourceLocatorException - Exception in net.sourceforge.czt.session: Exception thrown when source could not be found.
SourceLocatorException(Dialect, String, String) - Constructor for exception net.sourceforge.czt.session.SourceLocator.SourceLocatorException
SourceLocatorException(Dialect, String, String, Throwable) - Constructor for exception net.sourceforge.czt.session.SourceLocator.SourceLocatorException
startTransaction(Key<?>) - Method in interface net.sourceforge.czt.session.SectionInfo: Starts a section manager transaction.
startTransaction(Key<?>) - Method in class net.sourceforge.czt.session.SectionManager
StdInSource - Class in net.sourceforge.czt.session: Source from standard input.
StdInSource() - Constructor for class net.sourceforge.czt.session.StdInSource
StringSource - Class in net.sourceforge.czt.session: A source given as a String.
StringSource(String) - Constructor for class net.sourceforge.czt.session.StringSource
StringSource(String, String) - Constructor for class net.sourceforge.czt.session.StringSource

T

TimeStamp - Class in net.sourceforge.czt.session: This class implements precise timestamps and comparisons of them.
TimeStamp() - Constructor for class net.sourceforge.czt.session.TimeStamp
toString() - Method in enum net.sourceforge.czt.session.Dialect
toString() - Method in class net.sourceforge.czt.session.FileSource
toString() - Method in class net.sourceforge.czt.session.Key
toString() - Method in enum net.sourceforge.czt.session.KnownExtensions
toString() - Method in class net.sourceforge.czt.session.SectionManager
toString() - Method in class net.sourceforge.czt.session.StringSource
toString() - Method in class net.sourceforge.czt.session.UrlSource
traceConfig(String) - Static method in class net.sourceforge.czt.session.SectionManager
traceInfo(String) - Static method in class net.sourceforge.czt.session.AbstractCommand: Some complicated commands might require top-level trace information.
traceInfo(String) - Static method in class net.sourceforge.czt.session.SectionManager
traceLog(String) - Static method in class net.sourceforge.czt.session.AbstractCommand: Logs tracing information for this command to the underlying section manager.
traceLog(String) - Static method in class net.sourceforge.czt.session.SectionManager
traceWarning(String) - Static method in class net.sourceforge.czt.session.SectionManager
transactionStack_ - Variable in class net.sourceforge.czt.session.SectionManager: The transaction stack contains tracks active transactions.

U

UnknownCommandException - Exception in net.sourceforge.czt.session: Thrown only when the requested command is not known to the section manager
UnknownCommandException(Dialect) - Constructor for exception net.sourceforge.czt.session.UnknownCommandException
UnknownCommandException(Dialect, String) - Constructor for exception net.sourceforge.czt.session.UnknownCommandException
UnknownCommandException(Dialect, String, Throwable) - Constructor for exception net.sourceforge.czt.session.UnknownCommandException
UnknownCommandException(Dialect, Throwable) - Constructor for exception net.sourceforge.czt.session.UnknownCommandException
UrlSource - Class in net.sourceforge.czt.session: A source from an URL.
UrlSource(URL) - Constructor for class net.sourceforge.czt.session.UrlSource

V

valueOf(String) - Static method in enum net.sourceforge.czt.session.Dialect: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sourceforge.czt.session.KnownExtensions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sourceforge.czt.session.Markup: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.sourceforge.czt.session.Dialect: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sourceforge.czt.session.KnownExtensions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sourceforge.czt.session.Markup: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I K L M N P R S T U V