Index (javageci api 1.4.0 API)

A B C D E G H I J K L M N O P R S T W _
All Classes All Packages

A

activeIn(int) - Method in interface javax0.geci.api.Generator: Signal if a certain phase is needed by this generator.
allowDefaultSegment() - Method in interface javax0.geci.api.Source: Segments start and ends signalled with specific lines.
alternatives() - Method in interface javax0.geci.api.DirectoryLocator: Return the possible alternative directory names that can be used as source directory.
attributes() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher

B

borrows() - Method in interface javax0.geci.api.Source: A generator may decide to use the lines of the source as they are without the help of the Source object.
build() - Method in interface javax0.geci.api.GeneratorBuilder

C

close() - Method in interface javax0.geci.api.Segment: Usually this method is not implemented separately and is needed for to be auto closeable so that the segment can be used in a try-with-resources block.
COMMENT_TOUCH - Static variable in interface javax0.geci.api.Segment
comparator(BiPredicate<List<String>, List<String>>) - Method in interface javax0.geci.api.Geci: Set the source code comparator.
CompoundParams - Interface in javax0.geci.api
context() - Method in interface javax0.geci.api.Geci: Get the context of the Geci object that is injected into the generators.
context(Context) - Method in interface javax0.geci.api.Geci: Inject a context into the Geci object.
context(Context) - Method in interface javax0.geci.api.Generator: Generators wanting to use the context should implement this method.
Context - Interface in javax0.geci.api: The context is a global object available during the run-time of the generators that are executed under the same Geci engine instance.

D

debug(String, Object...) - Method in interface javax0.geci.api.Logger
DirectoryLocator - Interface in javax0.geci.api: A directory locator helps to find the directory for a given source set.
Distant - Interface in javax0.geci.api: A generator implementing this interface declares that it does not generate any source code, it keeps distance from the code only reading it and it does not touch any code.

E

equals(Object) - Method in class javax0.geci.api.Source.Set
error(String, Object...) - Method in interface javax0.geci.api.Logger
exists() - Static method in class javax0.geci.api.Source.Predicates: Creates the default predicate that tests true if the directory exists and is a directory.

G

Geci - Interface in javax0.geci.api
geci.api - module geci.api
GeciException - Exception in javax0.geci.api
GeciException() - Constructor for exception javax0.geci.api.GeciException
GeciException(String, Object...) - Constructor for exception javax0.geci.api.GeciException
GeciException(String, Throwable) - Constructor for exception javax0.geci.api.GeciException
GeciException(String, Throwable, boolean, boolean) - Constructor for exception javax0.geci.api.GeciException
GeciException(Throwable) - Constructor for exception javax0.geci.api.GeciException
generate() - Method in interface javax0.geci.api.Geci: Run the code generation.
Generator - Interface in javax0.geci.api: Generators get source code information from the framework and generate code.
GeneratorBuilder - Interface in javax0.geci.api
get(Object) - Method in interface javax0.geci.api.Context: Get the object associated with the key.
get(Object, Supplier<T>) - Method in interface javax0.geci.api.Context: Get the object associated with the key.
get(String) - Method in interface javax0.geci.api.CompoundParams: Get a parameter.
get(String, String) - Method in interface javax0.geci.api.CompoundParams: Get the parameter or return the defaults if the parameter is not defined.
get(String, Supplier<String>) - Method in interface javax0.geci.api.CompoundParams: Get the parameter or return the value supplied by the parameter defaultSupplier if the parameter is not defined.
getAbsoluteFile() - Method in interface javax0.geci.api.Source: Get the absolute file name of this source.
getContent() - Method in interface javax0.geci.api.Segment: Get the lines of the segment as it is at the moment.
getKlass() - Method in interface javax0.geci.api.Source: Get the class that corresponds to this source.
getKlassName() - Method in interface javax0.geci.api.Source: Get the name of the class that corresponds to this source.
getKlassSimpleName() - Method in interface javax0.geci.api.Source: Get the calculated class simple name.
getLines() - Method in interface javax0.geci.api.Source: Generators can use this method to read the whole content of a file.
getLogger() - Method in interface javax0.geci.api.Source: Get a logger that the generator can use to send messages to the logging system.
getPackageName() - Method in interface javax0.geci.api.Source: Get the name of the class where the class corresponding to the source is or should be.
getParam(String) - Method in interface javax0.geci.api.Segment: Get the value of a segment parameter that was set using the Segment.param(String...) method.
getSegmentPostface() - Method in interface javax0.geci.api.SegmentSplitHelper: In case of default segment creation the strings returned by this method will be inserted after the default segment.
getSegmentPreface() - Method in interface javax0.geci.api.SegmentSplitHelper: In case of default segment creation the strings returned by this method will be inserted before the default segment.
getValueList(String) - Method in interface javax0.geci.api.CompoundParams: Get the list of the values associated with the key.
getValueList(String, List<String>) - Method in interface javax0.geci.api.CompoundParams: Get the list of the values associated with the key.
GlobalGenerator - Interface in javax0.geci.api: A global generator is a generator that is to execute a specific code generation, which is for the whole application.

H

hasAllTheFiles(String...) - Static method in class javax0.geci.api.Source.Predicates: Returns a predicate that tests true if the file exists, it is a directory and a all of the files with the anchor names can be found in the directory.
hashCode() - Method in class javax0.geci.api.Source.Set
hasOneOfTheFiles(String...) - Static method in class javax0.geci.api.Source.Predicates: Returns a predicate that tests true if the file exists, it is a directory and a one of the files with the anchor names can be found in the directory.
hasTheFile(String) - Static method in class javax0.geci.api.Source.Predicates: Returns a predicate that tests true if the file exists, it is a directory and a file with the anchor name can be found in the directory.
headerLength() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher: The number of the lines that the header of the segment contains.

I

id() - Method in interface javax0.geci.api.CompoundParams: Shortcut to get("id")
id(String) - Method in interface javax0.geci.api.CompoundParams: Get the id from the parameters or the default value, which is the argument defaulT in case there is no id defined.
ignore(String...) - Method in interface javax0.geci.api.Geci: This method is the opposite of the method Geci.only(String...).
ignore(Predicate<Path>...) - Method in interface javax0.geci.api.Geci: Set filters to filter the sources.
ignoreBinary() - Method in interface javax0.geci.api.Geci: Ignore the files that cannot be read as text files.
info(String, Object...) - Method in interface javax0.geci.api.Logger
init(String) - Method in interface javax0.geci.api.Source: Initialize a segment.
is(String) - Method in interface javax0.geci.api.CompoundParams: Retrieves a parameter boolean value.
is(String, boolean) - Method in interface javax0.geci.api.CompoundParams: Retrieves a parameter boolean value if it exists.
is(String, String) - Method in interface javax0.geci.api.CompoundParams: Retrieves a parameter boolean value if it exists or tests a default value if it does not.
isDefaultSegmentEnd() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher: Checking the line that matches the "default" segment.
isNot(String) - Method in interface javax0.geci.api.CompoundParams
isSegmentEnd() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher
isSegmentStart() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher

J

javax0.geci.api - package javax0.geci.api

K

keySet() - Method in interface javax0.geci.api.CompoundParams: Returns the set of queryable keys.

L

Logger - Interface in javax0.geci.api

M

MAIN_RESOURCES - Static variable in interface javax0.geci.api.Geci
MAIN_SOURCE - Static variable in interface javax0.geci.api.Geci
mainResources() - Method in class javax0.geci.api.Source.Maven: See also Source.Maven.source(String, String, String)
mainSource() - Method in class javax0.geci.api.Source.Maven: See also Source.Maven.source(String, String, String)
match(String) - Method in interface javax0.geci.api.SegmentSplitHelper: Create a new matcher using the line to match against the segment start and end criteria.
match(List<String>, int) - Method in interface javax0.geci.api.SegmentSplitHelper: Create a matcher using the current line and possible reading consecutive or even previous lines.
maven() - Static method in interface javax0.geci.api.Source: Simple method to specify that the sources are in a maven project and they follow the standard directory structure.
maven(String) - Static method in interface javax0.geci.api.Source: This method can be used to specify that the directories are standard maven directories.
module(String) - Method in class javax0.geci.api.Source.Maven: Specify the maven module where the sources needing the code generation are.

N

newline() - Method in interface javax0.geci.api.Segment: Insert a new line into the segment.
newSource(String) - Method in interface javax0.geci.api.Source: Create a new source that may or may not exist.
newSource(Source.Set, String) - Method in interface javax0.geci.api.Source: Create a new source that may or may not exist.

O

only(String...) - Method in interface javax0.geci.api.Geci: Set filters to filter the sources.
only(Predicate<Path>...) - Method in interface javax0.geci.api.Geci: Set filters to filter the sources.
open() - Method in interface javax0.geci.api.Source: Open the "global" segment that is the whole source file.
open(String) - Method in interface javax0.geci.api.Source: Return the named segment that the generator can write.
originalLines() - Method in interface javax0.geci.api.Segment: Get the original lines of the segment as it was in the source code before starting to overwrite it.
output() - Method in interface javax0.geci.api.Geci: This method declares that the last source set defined is an output set.
output(Source.Set...) - Method in interface javax0.geci.api.Geci: This method declares that certain sets are output sets.

P

param(String...) - Method in interface javax0.geci.api.Segment: Define a parameter that can be used in the write methods.
paramKeySet() - Method in interface javax0.geci.api.Segment
phases() - Method in interface javax0.geci.api.Generator: Return the max number of phases this generator needs.
Predicates() - Constructor for class javax0.geci.api.Source.Predicates
process() - Method in interface javax0.geci.api.GlobalGenerator
process(Source) - Method in interface javax0.geci.api.Generator: Process the Source and presumably generate some code.
process(Source) - Method in interface javax0.geci.api.GlobalGenerator

R

register(Generator...) - Method in interface javax0.geci.api.Geci: Register one or more generator instances.
register(GeneratorBuilder...) - Method in interface javax0.geci.api.Geci: This is a convenience version of the register method that simply calls the build() on the arguments and then registers the generators.
resetParams() - Method in interface javax0.geci.api.Segment: Delete the previously defined parameters.
returns(List<String>) - Method in interface javax0.geci.api.Source: When a generator borrowed the source line (see Source.borrows() from the Source then it also has to returns the lines before it finishes its work.

S

safeOpen(String) - Method in interface javax0.geci.api.Source: Same as Source.open(String) but if the segment cannot be found then it throws a Geci exception instead of returning null
Segment - Interface in javax0.geci.api: A Segment object represents an editor-fold part in the source file that the code generator can write.
segmentNames() - Method in interface javax0.geci.api.Source: Get all the segment names that are defined in the source
SegmentSplitHelper - Interface in javax0.geci.api: A SegmentSplitHelper helps to identify the start and end of the segments in a source file and that way it helps to split up the source code.
SegmentSplitHelper.Matcher - Interface in javax0.geci.api: A matcher that can be used to decide if a line starts a segment or ends a segment.
set() - Static method in class javax0.geci.api.Source.Set
set(String) - Static method in class javax0.geci.api.Source.Set: Import this method as a static import into the generators and into the test code that invokes the code generator.
set(String, boolean) - Static method in class javax0.geci.api.Source.Set: Crete a new set with the name name.
setConstraints(Source, String, Set<String>) - Method in interface javax0.geci.api.CompoundParams: Set the constraints that this CompoundParameters should adhere.
setContent(String) - Method in interface javax0.geci.api.Segment: Set the content of the segment.
setPostface(String...) - Method in interface javax0.geci.api.Segment: See the documentation of Segment.setPreface(String...)
setPreface(String...) - Method in interface javax0.geci.api.Segment: When the generator does not find a segment based on the starting and ending line it may decide to insert the segment towards the end of the file.
source(String...) - Method in interface javax0.geci.api.Geci: Add a new directory to the list of source directories that Geci should process.
source(String, Source.NamedSourceSet) - Method in interface javax0.geci.api.Geci: Set the source set with the given name specified in the set parameter but use the array of directory names from the parameter nameAndSet.
source(Predicate<String>, String...) - Method in interface javax0.geci.api.Geci: Add a new directory to the list of source directories that Geci should process.
source(DirectoryLocator) - Method in interface javax0.geci.api.Geci: Same as Geci.source(Source.Set, DirectoryLocator) but without naming the souzrce set.
source(Source.Maven) - Method in interface javax0.geci.api.Geci: Register the four standard maven directories as source sets.
source(Source.NamedSourceSet) - Method in interface javax0.geci.api.Geci: Set the source set with the given name specified in the nameAndSet parameter that has the name as well as the array of directory names.
source(Source.Set, String...) - Method in interface javax0.geci.api.Geci: Add a new directory to the list of source directories that Geci should process.
source(Source.Set, Predicate<String>, String...) - Method in interface javax0.geci.api.Geci: Add a new directory to the list of source directories that Geci should process.
source(Source.Set, DirectoryLocator) - Method in interface javax0.geci.api.Geci: Define the sources using an implementation of the interface DirectoryLocator.
source(Source.Set, Source.NamedSourceSet) - Method in interface javax0.geci.api.Geci: Set the source set with the given name specified in the set parameter but use the array of directory names from the parameter nameAndSet.
Source - Interface in javax0.geci.api: A Source represents a source file in the project that the generator can modify.
Source.Maven - Class in javax0.geci.api: Class to build up the directory structures that correspond to the Maven directory structure
Source.NamedSourceSet - Class in javax0.geci.api
Source.Predicates - Class in javax0.geci.api: This class provides predicates that can be used as an argument to the methods Geci.source(Predicate, String...) and Geci.source(Set, Predicate, String...).
Source.Set - Class in javax0.geci.api: Set serves as an identifier class for a source set.
sourceParams() - Method in interface javax0.geci.api.Segment: Get the parameters that were defined in the source.
splitHelper(String, SegmentSplitHelper) - Method in interface javax0.geci.api.Geci: Register a new SegmentSplitHelper associated with the file name extension.

T

tabbing() - Method in interface javax0.geci.api.SegmentSplitHelper.Matcher
temporary() - Method in interface javax0.geci.api.Source: Create a temporary segment.
test(String) - Method in interface javax0.geci.api.DirectoryLocator: Test that the predicate match the given file name.
TEST_RESOURCES - Static variable in interface javax0.geci.api.Geci
TEST_SOURCE - Static variable in interface javax0.geci.api.Geci
testResources() - Method in class javax0.geci.api.Source.Maven: See also Source.Maven.source(String, String, String)
testSource() - Method in class javax0.geci.api.Source.Maven: See also Source.Maven.source(String, String, String)
toBoolean(String) - Static method in interface javax0.geci.api.CompoundParams
toString() - Method in class javax0.geci.api.Source.Set
touch(long) - Method in interface javax0.geci.api.Segment: A Source object, as implemented in the engine (not in the API though) is touched when a generator has written anything into any segment.
trace(String) - Method in interface javax0.geci.api.Geci: Instruct the framework to create a trace file for this instance and save the trace information into the file named by the argument.
trace(String, Object...) - Method in interface javax0.geci.api.Logger
traceLines() - Method in interface javax0.geci.api.Segment: Trace the lines of the segment.
traceParams() - Method in interface javax0.geci.api.Segment: Trace the parameters
tryRename() - Method in class javax0.geci.api.Source.Set: When a set was automatically named, like mainSource then it may happen that there are more than one sets with that name.

W

warning(String, Object...) - Method in interface javax0.geci.api.Logger
write(String, Object...) - Method in interface javax0.geci.api.Segment: Write a line to the segment after the last line.
write(Segment) - Method in interface javax0.geci.api.Segment: Write all the lines of the segment into this segment.
write_l(String, Object...) - Method in interface javax0.geci.api.Segment: Write a line into the segment after the last line and after decreasing the indenting.
write_r(String, Object...) - Method in interface javax0.geci.api.Segment: Write a line into the segment after the last line and increase the indenting for the coming lines.

_

_l(String, Object...) - Method in interface javax0.geci.api.Segment
_r(String, Object...) - Method in interface javax0.geci.api.Segment

A B C D E G H I J K L M N O P R S T W _
All Classes All Packages