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

A

addFragment(String, String) - Method in class org.fulib.tools.CodeFragments

Allows specifying fragments that can be inserted but don't have to be present in source files.

addPipe(String, Pipe) - Method in class org.fulib.tools.CodeFragments

Adds or replaces a pipe with the given name.

apply(String, String) - Method in class org.fulib.tools.pipe.CodeFencePipe

apply(String, String) - Method in class org.fulib.tools.pipe.HtmlPipe

apply(String, String) - Method in class org.fulib.tools.pipe.IndentPipe

apply(String, String) - Method in class org.fulib.tools.pipe.JavaDocPipe

apply(String, String) - Method in interface org.fulib.tools.pipe.Pipe

Transforms the input text of the code fragment to the output format specified by this pipe.

C

classDiagrams() - Static method in class org.fulib.FulibTools

To create a class diagram png for usage in java doc comments, dumpPng(model) creates file .../doc-files/classDiagram.png within the model source folder

ClassDiagrams - Class in org.fulib.tools

Provides various methods for storing class diagrams as files.

ClassDiagrams() - Constructor for class org.fulib.tools.ClassDiagrams

CodeFencePipe - Class in org.fulib.tools.pipe

A pipe that puts the input text into a markdown code fence.

CodeFencePipe() - Constructor for class org.fulib.tools.pipe.CodeFencePipe

CodeFencePipe(String) - Constructor for class org.fulib.tools.pipe.CodeFencePipe

codeFragments() - Static method in class org.fulib.FulibTools

Example use:

CodeFragments - Class in org.fulib.tools

Provides a data structure for mapping keys to code fragments, which can be loaded from and inserted into files via special comments.

CodeFragments() - Constructor for class org.fulib.tools.CodeFragments

D

dump(Object...) - Static method in class fulib.od

Deprecated.

since 1.2; use objectDiagrams().dumpPng(objects...) instead

dump(ClassModel, String, Format) - Method in class org.fulib.tools.ClassDiagrams

Creates a class diagram of the given class model at the path specified by diagramFileName in the given Graphviz format.

dump(String, Object) - Method in class org.fulib.tools.ScenarioDiagrams

dumpPng(ClassModel) - Method in class org.fulib.tools.ClassDiagrams

Create a class diagram of the given class model at the path modelFolder/doc-files/classDiagram.png.

dumpPng(ClassModel, String) - Method in class org.fulib.tools.ClassDiagrams

Creates a class diagram of the given class model at the path specified by diagramFileName in png format.

dumpPng(Object...) - Method in class org.fulib.tools.ObjectDiagrams

create an object diagram png in tmp/TheFirstObjectsClass.1.png
Example:

dumpPng(String, Object...) - Method in class org.fulib.tools.ObjectDiagrams

Create object diagrams.

dumpSVG(ClassModel, String) - Method in class org.fulib.tools.ClassDiagrams

Creates a class diagram of the given class model at the path specified by diagramFileName in svg format.

dumpSVG(String, Object...) - Method in class org.fulib.tools.ObjectDiagrams

Create object diagrams.

dumpYaml(String, Object...) - Method in class org.fulib.tools.ObjectDiagrams

Create yaml description.

F

fulib - package fulib

FulibTools - Class in org.fulib

FulibTools() - Constructor for class org.fulib.FulibTools

G

getFragment(String) - Method in class org.fulib.tools.CodeFragments

getFragmentMap() - Method in class org.fulib.tools.CodeFragments

Deprecated.

since 1.2; use CodeFragments.getFragments() instead

getFragments() - Method in class org.fulib.tools.CodeFragments

getPipe(String) - Method in class org.fulib.tools.CodeFragments

getScale() - Method in class org.fulib.tools.ClassDiagrams

getScale() - Method in class org.fulib.tools.ObjectDiagrams

H

HtmlPipe - Class in org.fulib.tools.pipe

A pipe that escapes any HTML4 special characters using HTML entities.

HtmlPipe() - Constructor for class org.fulib.tools.pipe.HtmlPipe

I

IndentPipe - Class in org.fulib.tools.pipe

A pipe that indents each line of the input text with 4 spaces.

IndentPipe() - Constructor for class org.fulib.tools.pipe.IndentPipe

J

JavaDocPipe - Class in org.fulib.tools.pipe

A pipe that wraps the input text for use in Javadoc comments.

JavaDocPipe() - Constructor for class org.fulib.tools.pipe.JavaDocPipe

L

load(String...) - Method in class org.fulib.tools.CodeFragments

Loads code fragments from all files within the given folders.

N

NAME - Static variable in class org.fulib.tools.pipe.CodeFencePipe

NAME - Static variable in class org.fulib.tools.pipe.HtmlPipe

NAME - Static variable in class org.fulib.tools.pipe.IndentPipe

NAME - Static variable in class org.fulib.tools.pipe.JavaDocPipe

O

objectDiagrams() - Static method in class org.fulib.FulibTools

Create object diagrams.

ObjectDiagrams - Class in org.fulib.tools

Create object diagrams.

ObjectDiagrams() - Constructor for class org.fulib.tools.ObjectDiagrams

od - Class in fulib

Deprecated.

since 1.2; use objectDiagrams() instead

od() - Constructor for class fulib.od

Deprecated.

org.fulib - package org.fulib

org.fulib.tools - package org.fulib.tools

org.fulib.tools.pipe - package org.fulib.tools.pipe

P

Pipe - Interface in org.fulib.tools.pipe

A pipe can transform the input text of a code fragment to a different output format.

R

removePipe(String) - Method in class org.fulib.tools.CodeFragments

Removes the pipe with the given name if one exists, otherwise does nothing.

S

scenarioDiagrams() - Static method in class org.fulib.FulibTools

ScenarioDiagrams - Class in org.fulib.tools

ScenarioDiagrams() - Constructor for class org.fulib.tools.ScenarioDiagrams

setScale(double) - Method in class org.fulib.tools.ClassDiagrams

setScale(double) - Method in class org.fulib.tools.ObjectDiagrams

T

tables() - Static method in class org.fulib.FulibTools

Deprecated.

since 1.2; use HtmlRenderer provided by FulibTables.

Tables - Class in org.fulib.tools

Deprecated.

since 1.2; use HtmlRenderer provided by FulibTables.

Tables() - Constructor for class org.fulib.tools.Tables

Deprecated.

toHtml(Object) - Method in class org.fulib.tools.Tables

Deprecated.

since 1.2; use HtmlRenderer provided by FulibTables.

U

update(String...) - Method in class org.fulib.tools.CodeFragments

Runs CodeFragments.load(String...) and CodeFragments.write(String...) in succession.

updateCodeFragments(String...) - Method in class org.fulib.tools.CodeFragments

Deprecated.

since 1.2; use CodeFragments.update(String...) and CodeFragments.getFragments() instead

W

withScale(double) - Method in class org.fulib.tools.ClassDiagrams

Sets the scaling factor to use when rendering (applies to PNG and SVG format).

withScale(double) - Method in class org.fulib.tools.ObjectDiagrams

Sets the scaling factor to use when rendering (applies to PNG and SVG format).

write(String...) - Method in class org.fulib.tools.CodeFragments

Inserts code fragments into all files within the given folders.

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