Index (semplate-lib 0.2 API)

A C D E F G I M O P R S T U V W
All Classes All Packages

A

add(String, String, ValueMap) - Method in class semplate.valuemap.ValueMap: Add a value map to a list of value maps associated with a field.
assembleSemanticBlock(String) - Method in class semplate.SemanticTemplateWriter: Reads in a text containing field specifications and creates a semantic block for it

C

commentDelimiter - Variable in class semplate.SemanticTemplateWriter: The delimiters used for comments in the mark down file
containsField(String) - Method in class semplate.valuemap.ValueMap: Test if the specified field name maps has a mapping to an value.
ConversionException - Exception in semplate.valuemap: Thrown when a ValueMap cannot be converted to an object
ConversionException() - Constructor for exception semplate.valuemap.ConversionException: Constructs a ConversionException with null as its error message string.
ConversionException(String) - Constructor for exception semplate.valuemap.ConversionException: Constructs a ConversionException, saving a reference to the error message string for later retrieval by the getMessage method.
ConversionException(String, Throwable) - Constructor for exception semplate.valuemap.ConversionException: Constructs a new ConversionException with the specified detail message and cause.
ConversionException(Throwable) - Constructor for exception semplate.valuemap.ConversionException: Constructs a ConversionException, saving a reference to the original cause of the exception.

D

dataObject - Variable in class semplate.SemanticTemplateWriter: The object containing the data for the output file
delimiters - Variable in class semplate.SemanticTemplateWriter: Any delimiters used around data in the output file

E

empty() - Static method in class semplate.valuemap.ValueMap: Creates a mutable empty value map.

F

fieldNames() - Method in class semplate.valuemap.ValueMap: Generates a set with the field names on this value map
from(Object) - Static method in class semplate.valuemap.ValueMap: Creates a value map from the specified data object.
from(Iterator<?>) - Static method in class semplate.valuemap.ValueMap: Creates a value map from the specified iterator.

G

getValue(String) - Method in class semplate.valuemap.ValueMap: Returns an optional value mapped to the specified field name.
getValueMap(String) - Method in class semplate.valuemap.ValueMap: Returns an optional value map that is mapped to the specified field name.
getValueMaps() - Method in class semplate.valuemap.ValueMap: Returns a list of all value maps contained in the fields of this value map
getValueMaps(String) - Method in class semplate.valuemap.ValueMap: Returns a list of ValueMaps that are subordinate to the specified fieldname.

I

isEmpty() - Method in class semplate.valuemap.ValueMap: Test if this value map is empty.
isValueMap(String) - Method in class semplate.valuemap.ValueMap: Test if the specified field name maps to a value map.

M

mapInlineFieldSpec(String) - Method in class semplate.SemanticTemplateWriter: Takes string of the form
merge(ValueMap) - Method in class semplate.valuemap.ValueMap: Merges a value map with this one.

O

of(String) - Static method in class semplate.valuemap.ValueMap: Returns a value map containing one value constructed from the specified nameValuePair string.
of(List<String>, String) - Static method in class semplate.valuemap.ValueMap: Returns a value map containing one value.

P

put(String, Object) - Method in class semplate.valuemap.ValueMap: Sets a mapping between the specified field name and a value object.

R

read() - Method in class semplate.SemanticReader: Reads a semantically annotated markdown file and creates a data object populated with the data in the file.
ReadException - Exception in semplate: Thrown when either a markdown template or semantically annotated markdown file cannot be read.
ReadException() - Constructor for exception semplate.ReadException: Constructs a ReadException with null as its error message string.
ReadException(String) - Constructor for exception semplate.ReadException: Constructs a ReadException, saving a reference to the error message string for later retrieval by the getMessage method.
ReadException(String, Throwable) - Constructor for exception semplate.ReadException: Constructs a new ReadException with the specified detail message and cause.
ReadException(Throwable) - Constructor for exception semplate.ReadException: Constructs a ReadException, saving a reference to the original cause of the exception.

S

SemanticReader - Class in semplate: Reads semantically annotated markdown files and constructs data objects from them.
SemanticTemplateWriter - Class in semplate: Writes a semantically annotated markdown file using a data object containing the data and a template file.
SemanticWriter - Class in semplate: Updates existing semantically annotated markdown files using new data.
semplate - package semplate: Creates, updates and reads semantically annotated markdown files.
semplate.annotations - package semplate.annotations
semplate.valuemap - package semplate.valuemap: Provides classes for an opinionated approach to Java reflection.

T

Templatable - Annotation Type in semplate.annotations: Used to annotate classes that can be read by the semplate library
TemplateField - Annotation Type in semplate.annotations: Use to mark fields whose data is to be used by the #semplate.Template class.
templatePath - Variable in class semplate.SemanticTemplateWriter: The template file
toObject(Class<?>) - Method in class semplate.valuemap.ValueMap: Creates an object from the specified class using the data in this value map.
toString() - Method in class semplate.valuemap.ValueMap: Returns a non-empty string representation of this ValueMaP suitable for debugging.

U

UpdateException - Exception in semplate: Thrown when a semantically annotated markdown file cannot be updated.
UpdateException() - Constructor for exception semplate.UpdateException: Constructs a UpdateException with null as its error message string.
UpdateException(String) - Constructor for exception semplate.UpdateException: Constructs a UpdateException, saving a reference to the error message string for later retrieval by the getMessage method.
UpdateException(String, Throwable) - Constructor for exception semplate.UpdateException: Constructs a new UpdateException with the specified detail message and cause.
usingFile(Path) - Method in class semplate.SemanticReader: Specifies the semantically annotated markdown file to be read.
usingFile(Path) - Method in class semplate.SemanticWriter: Specifies the semantically annotated markdown file to be updated.
usingTemplate(String) - Method in class semplate.SemanticWriter: Specifies the name of the template file used to generate the semantically annotated markdown file.
usingTemplate(Path) - Method in class semplate.SemanticWriter: Specifies the template file used to generate the semantically annotated markdown file.

V

ValueMap - Class in semplate.valuemap: Maps values to field names.
ValueMap() - Constructor for class semplate.valuemap.ValueMap

W

with(Class<?>) - Static method in class semplate.SemanticReader: Specifies the class of the data object that is created when the semantically annotated markdown file is read.
with(Object) - Static method in class semplate.SemanticWriter: Set up the data object whose data is to be written to a semantically annotated markdown file.
write(Path) - Method in class semplate.SemanticTemplateWriter: Generates a semantically annotated markdown file from a template.
write(Path) - Method in class semplate.SemanticWriter: Writes a semantically annotated markdown file.
WriteException - Exception in semplate: Thrown when either a semantically annotated markdown file cannot be created or written.
WriteException() - Constructor for exception semplate.WriteException: Constructs a WriteException with null as its error message string.
WriteException(String) - Constructor for exception semplate.WriteException: Constructs a WriteException, saving a reference to the error message string for later retrieval by the getMessage method.
WriteException(String, Throwable) - Constructor for exception semplate.WriteException: Constructs a new WriteException with the specified detail message and cause.
WriteException(Throwable) - Constructor for exception semplate.WriteException: Constructs a WriteException, saving a reference to the original cause of the exception.

A C D E F G I M O P R S T U V W
All Classes All Packages