A B C D E G H I L M N O P R S T U V X 
All Classes All Packages

A

AbstractTemplateCustomization - Class in org.rodnansol.core.generator.template.customization
Class represents a template customization object.
AbstractTemplateCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
addChildGroup(PropertyGroup) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
Add a new child group.
addItemToMemory(String, Object) - Method in interface org.rodnansol.core.generator.template.compiler.TemplateCompilerMemoryStore
Adds item to the memory store.
addItemToMemory(String, Object) - Method in class org.rodnansol.core.generator.template.compiler.ThreadLocalTemplateCompilerStore
 
addProperty(Property) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
Add a new property to the property group.
ADOC - org.rodnansol.core.generator.template.TemplateType
 
AggregationAction - Class in org.rodnansol.core.action
Class representing aggregation action.
AggregationAction(Project, List<File>, File) - Constructor for class org.rodnansol.core.action.AggregationAction
 
AggregationDocumenter - Class in org.rodnansol.core.generator.writer
Class aggregates the incoming inputs into one big output file.
AggregationDocumenter(MetadataReader, TemplateCompiler, MetadataInputResolverContext, PropertyGroupFilterService) - Constructor for class org.rodnansol.core.generator.writer.AggregationDocumenter
 
AsciiDocTemplateCustomization - Class in org.rodnansol.core.generator.template.customization
Class representing extra customizations for the AsciiDoc template.
AsciiDocTemplateCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
AsciiDocTemplateCustomization.TocPlacement - Enum in org.rodnansol.core.generator.template.customization
 
AUTO - org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
 

B

basedir - Variable in class org.rodnansol.core.project.Project
 

C

CombinedInput - Class in org.rodnansol.core.generator.writer
 
CombinedInput(File, String, String) - Constructor for class org.rodnansol.core.generator.writer.CombinedInput
 
COMPACT - org.rodnansol.core.generator.template.TemplateMode
This template mode is only containing the properties without any information about the property groups.
compileTemplate(String, TemplateData) - Method in interface org.rodnansol.core.generator.template.compiler.TemplateCompiler
Compiles the template with the given template data.
compileTemplate(String, TemplateData) - Method in class org.rodnansol.core.generator.template.handlebars.HandlebarsTemplateCompiler
 
contentCustomization - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Field storing customization options for the content template.
ContentCustomization - Class in org.rodnansol.core.generator.template.customization
Class containing header customization data.
ContentCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.ContentCustomization
 
convertToEnvVariable(String) - Static method in class org.springframework.boot.context.properties.source.SystemEnvironmentPropertyMapperDelegator
Converts the incoming property to its environment variable form.
CoreFileUtils - Class in org.rodnansol.core.util
Class containing utility methods.
CreateAggregationCommand - Class in org.rodnansol.core.generator.writer
Class representing the aggregation action command.
CreateAggregationCommand(Project, String, List<CombinedInput>, TemplateType, TemplateCustomization, File) - Constructor for class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
CreateDocumentCommand - Class in org.rodnansol.core.generator.writer
Class representing the document creation command.
CreateDocumentCommand(Project, String, File, String, File, TemplateCustomization) - Constructor for class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
createDocumentsAndAggregate(CreateAggregationCommand) - Method in class org.rodnansol.core.generator.writer.AggregationDocumenter
Aggregates the incoming inputs into one big file and writes it to the disk.
createUnknownGroup() - Static method in class org.rodnansol.core.generator.template.data.PropertyGroup
Creates a group that has 'Unknown' type and source type.
CustomTemplate - Class in org.rodnansol.core.generator.writer
Class representing a customization for the templates.
CustomTemplate(String, String, String) - Constructor for class org.rodnansol.core.generator.writer.CustomTemplate
 

D

Documenter - Class in org.rodnansol.core.generator.writer
Class using the MetadataReader and TemplateCompiler to read the incoming metadata file and render it to the final file.
Documenter(MetadataReader, TemplateCompiler, MetadataInputResolverContext, PropertyGroupFilterService) - Constructor for class org.rodnansol.core.generator.writer.Documenter
 
DocumentGenerationAction - Class in org.rodnansol.core.action
Action class for single document generation.
DocumentGenerationAction(Project, String, TemplateCustomization, TemplateType, File) - Constructor for class org.rodnansol.core.action.DocumentGenerationAction
 
DocumentGenerationException - Exception in org.rodnansol.core.generator
Exception to be thrown when the document generation flow can not be finished.
DocumentGenerationException(String) - Constructor for exception org.rodnansol.core.generator.DocumentGenerationException
 
DocumentGenerationException(String, Throwable) - Constructor for exception org.rodnansol.core.generator.DocumentGenerationException
 

E

equals(Object) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
equals(Object) - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
equals(Object) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
equals(Object) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
equals(Object) - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
equals(Object) - Method in class org.rodnansol.core.generator.template.data.Property
 
equals(Object) - Method in class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
equals(Object) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
equals(Object) - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
execute() - Method in class org.rodnansol.core.action.DocumentGenerationAction
Sets up the template files and the output file, then executes the generation.
executeAggregation() - Method in class org.rodnansol.core.action.AggregationAction
 

G

getAggregatedDocumentHeader() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getAggregatedProperties() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getAggregatedProperties() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getAggregatedProperties() - Method in interface org.rodnansol.core.generator.template.data.TemplateData
Returns all properties associated with the template data.
getBackgroundColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getBasedir() - Method in class org.rodnansol.core.project.Project
 
getChildrenGroups() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getCodeColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getCollapsibleHoverColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getCombinedInputs() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getCombinedTemplate() - Method in class org.rodnansol.core.generator.template.TemplateResource
 
getContentCustomization() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
getContentCustomization() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Returns the template content customization.
getContentTemplate() - Method in class org.rodnansol.core.generator.template.TemplateResource
 
getContentTemplate(TemplateMode) - Method in enum org.rodnansol.core.generator.template.TemplateType
 
getCustomContentTemplate() - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
getCustomFooterTemplate() - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
getCustomHeaderTemplate() - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
getCustomTemplate() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getDefaultAggregatedTargetFilePath(String) - Method in class org.rodnansol.core.project.gradle.GradleProject
 
getDefaultAggregatedTargetFilePath(String) - Method in class org.rodnansol.core.project.maven.MavenProject
 
getDefaultAggregatedTargetFilePath(String) - Method in class org.rodnansol.core.project.Project
Returns the output file path based on the Project instance and template type value.
getDefaultCompiler() - Static method in class org.rodnansol.core.generator.template.compiler.TemplateCompilerFactory
Returns the default provided instance which is the HandlebarsTemplateCompiler.
getDefaultCompilerName() - Static method in class org.rodnansol.core.generator.template.compiler.TemplateCompilerFactory
Returns the class name of the defualt compiler.
getDefaultOutputFolder() - Method in class org.rodnansol.core.project.gradle.GradleProject
 
getDefaultOutputFolder() - Method in class org.rodnansol.core.project.maven.MavenProject
 
getDefaultOutputFolder() - Method in class org.rodnansol.core.project.Project
Returns the default output folder based on the Project instance.
getDefaultOutputFolder(String) - Method in class org.rodnansol.core.project.gradle.GradleProject
 
getDefaultOutputFolder(String) - Method in class org.rodnansol.core.project.maven.MavenProject
 
getDefaultOutputFolder(String) - Method in class org.rodnansol.core.project.Project
Returns the default output folder based on the Project instance and module name (in multi-module setup).
getDefaultTargetFilePath(TemplateType) - Method in class org.rodnansol.core.project.gradle.GradleProject
 
getDefaultTargetFilePath(TemplateType) - Method in class org.rodnansol.core.project.maven.MavenProject
 
getDefaultTargetFilePath(TemplateType) - Method in class org.rodnansol.core.project.Project
Returns the output file path based on the Project instance and template type value.
getDefaultTemplateCustomizationByType(TemplateType) - Static method in class org.rodnansol.core.generator.template.customization.TemplateCustomizationFactory
Returns an empty TemplateCustomization instance for the given template type.
getDefaultValue() - Method in class org.rodnansol.core.generator.template.data.Property
 
getDescription() - Method in class org.rodnansol.core.generator.template.data.Property
 
getDescription() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getDescription() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getDescription() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getEvenTableRowColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getExcludedGroups() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getExcludedGroups() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getExcludedGroups() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getExcludedProperties() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getExcludedProperties() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getExcludedProperties() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getExtension() - Method in enum org.rodnansol.core.generator.template.TemplateType
 
getFooterTemplate() - Method in class org.rodnansol.core.generator.template.TemplateResource
 
getFooterTemplate(TemplateMode) - Method in enum org.rodnansol.core.generator.template.TemplateType
 
getFqName() - Method in class org.rodnansol.core.generator.template.data.Property
 
getGenerationDate() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getGenerationDate() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getGroupName() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getHeaderTemplate() - Method in class org.rodnansol.core.generator.template.TemplateResource
 
getHeaderTemplate(TemplateMode) - Method in enum org.rodnansol.core.generator.template.TemplateType
 
getIncludedGroups() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getIncludedGroups() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getIncludedGroups() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getIncludedProperties() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getIncludedProperties() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getIncludedProperties() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getInput() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getInputStreamFromFile(Project, File) - Method in class org.rodnansol.core.generator.resolver.MetadataInputResolverContext
Returns the requested file from the given input.
getInstance(String) - Static method in class org.rodnansol.core.generator.template.compiler.TemplateCompilerFactory
Returns a TemplateCompiler instance by its class name.
getInstanceByClassName(String) - Static method in class org.rodnansol.core.generator.template.compiler.TemplateCompilerFactory
Instantiates the incoming class by its name.
getItem(String) - Method in interface org.rodnansol.core.generator.template.compiler.TemplateCompilerMemoryStore
Returns an item from the store.
getItem(String) - Method in class org.rodnansol.core.generator.template.compiler.ThreadLocalTemplateCompilerStore
 
getKey() - Method in class org.rodnansol.core.generator.template.data.Property
 
getLastTableRowColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getLinkColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getLocale() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
getLocale() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Returns the set locale.
getMainDescription() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getMainName() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getMemoryStore() - Method in interface org.rodnansol.core.generator.template.compiler.TemplateCompiler
Returns the associated memory store.
getMetadataInput() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getModuleDescription() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getModuleName() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getModules() - Method in class org.rodnansol.core.project.Project
 
getName() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getName() - Method in class org.rodnansol.core.project.Project
 
getOutput() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getOutput() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getParentGroup() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getPossibleMetadataFilePaths() - Method in class org.rodnansol.core.project.gradle.GradleProject
 
getPossibleMetadataFilePaths() - Method in class org.rodnansol.core.project.maven.MavenProject
 
getPossibleMetadataFilePaths() - Method in class org.rodnansol.core.project.Project
Returns the list of the possible metadata file paths inside a project.
getPossibleMetadataFilePaths() - Method in class org.rodnansol.core.project.simple.SimpleProject
 
getProject() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getProject() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getProjectType() - Method in class org.rodnansol.core.project.Project
 
getProperties() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getPropertyDeprecation() - Method in class org.rodnansol.core.generator.template.data.Property
 
getPropertyGroups() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getPropertyGroups() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getPropertyGroups() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getReason() - Method in class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
getReplacement() - Method in class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
getSectionName() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
getSingleTemplate(TemplateMode) - Method in enum org.rodnansol.core.generator.template.TemplateType
 
getSourceType() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getSubTemplateDataList() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getTableRowBorderColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getTableRowColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getTemplate() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getTemplateCustomization() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
getTemplateCustomization() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
getTemplateCustomization() - Method in interface org.rodnansol.core.generator.template.data.TemplateData
Returns the template customization data.
getTemplateCustomization() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getTemplateCustomization() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
getTemplateCustomization() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
getTemplateMode() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
getTemplateMode() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Controls if the template should be rendered in compact mode or not.
getTemplateType() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
getTextColor() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
getTocLevels() - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
getTocPlacement() - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
getTocTitle() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
getTocTitle() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Returns the 'Table of Contents' section title.
getType() - Method in class org.rodnansol.core.generator.template.data.Property
 
getType() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
getUnknownGroupLocalization() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
getUnknownGroupLocalization() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Returns the title for the unknown group.
GRADLE - org.rodnansol.core.project.ProjectType
 
GradleProject - Class in org.rodnansol.core.project.gradle
Class representing a Gradle project.
GradleProject(File, String) - Constructor for class org.rodnansol.core.project.gradle.GradleProject
 
GradleProject(File, String, List<String>) - Constructor for class org.rodnansol.core.project.gradle.GradleProject
 

H

HandlebarsTemplateCompiler - Class in org.rodnansol.core.generator.template.handlebars
Template compiler implementation that uses Handlebarsto compile a template.
HandlebarsTemplateCompiler() - Constructor for class org.rodnansol.core.generator.template.handlebars.HandlebarsTemplateCompiler
 
HandlebarsTemplateCompiler(Handlebars, I18nHelper) - Constructor for class org.rodnansol.core.generator.template.handlebars.HandlebarsTemplateCompiler
 
hashCode() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
hashCode() - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
hashCode() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
hashCode() - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
hashCode() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
hashCode() - Method in class org.rodnansol.core.generator.template.data.Property
 
hashCode() - Method in class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
hashCode() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
hashCode() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
headerEnabled - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
If the header should be enabled or not.
HTML - org.rodnansol.core.generator.template.TemplateType
 
HtmlTemplateCustomization - Class in org.rodnansol.core.generator.template.customization
Class representing HTML customizations.
HtmlTemplateCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 

I

includeEnvFormat - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Deprecated, for removal: This API element is subject to removal in a future version.
includeGenerationDate - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
If the generation date should be rendered into the document or not.
includeUnknownGroup - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
If the 'Unknown group' should be included or not.
initializeFileWithPath(File) - Static method in class org.rodnansol.core.util.CoreFileUtils
Initialize a file and its parent directories and returns the file.
initializeFileWithPath(String) - Static method in class org.rodnansol.core.util.CoreFileUtils
Initialize a file and its parent directories and returns the file.
INSTANCE - Static variable in class org.rodnansol.core.generator.reader.MetadataReader
 
INSTANCE - Static variable in class org.rodnansol.core.generator.resolver.MetadataInputResolverContext
 
INSTANCE - Static variable in class org.rodnansol.core.generator.template.compiler.ThreadLocalTemplateCompilerStore
 
INSTANCE - Static variable in class org.rodnansol.core.generator.template.handlebars.HandlebarsTemplateCompiler
 
INSTANCE - Static variable in class org.rodnansol.core.generator.writer.postprocess.PropertyGroupFilterService
 
isHeaderEnabled() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isIncludeClass() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeDefaultValue() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeDeprecation() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeDescription() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeEnvFormat() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isIncludeEnvFormat() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeEnvFormat() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
isIncludeGenerationDate() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isIncludeGenerationDate() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
If the generation date should be rendered into the document or not.
isIncludeKey() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeType() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
isIncludeUnknownGroup() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isIncludeUnknownGroup() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
If the unknown group should be included or not in the final rendered document or not.
isJarOrZipFile(File) - Static method in class org.rodnansol.core.util.CoreFileUtils
Checks if the input is a JAR or ZIP file based on its extension.
isNested() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
isRemoveEmptyGroups() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isRemoveEmptyGroups() - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
If empty groups must be removed from the final document or not.
isTableOfContentsEnabled() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
isUnknownGroup() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 

L

LEFT - org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
 
locale - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Locale to be used during the i18n process.
LOGGER - Static variable in class org.rodnansol.core.generator.template.compiler.ThreadLocalTemplateCompilerStore
 

M

MainTemplateData - Class in org.rodnansol.core.generator.template.data
Class representing the main template data.
MainTemplateData(String, List<PropertyGroup>) - Constructor for class org.rodnansol.core.generator.template.data.MainTemplateData
 
MARKDOWN - org.rodnansol.core.generator.template.TemplateType
 
MarkdownTemplateCustomization - Class in org.rodnansol.core.generator.template.customization
Class representing Markdown template customizations.
MarkdownTemplateCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.MarkdownTemplateCustomization
 
MAVEN - org.rodnansol.core.project.ProjectType
 
MavenProject - Class in org.rodnansol.core.project.maven
Class representing a Maven project.
MavenProject(File, String) - Constructor for class org.rodnansol.core.project.maven.MavenProject
 
MavenProject(File, String, List<String>) - Constructor for class org.rodnansol.core.project.maven.MavenProject
 
MetadataConversionException - Exception in org.rodnansol.core.generator.reader
Exception to be thrown when an error occurs at the metadata conversion.
MetadataConversionException(String) - Constructor for exception org.rodnansol.core.generator.reader.MetadataConversionException
 
MetadataConversionException(String, Throwable) - Constructor for exception org.rodnansol.core.generator.reader.MetadataConversionException
 
MetadataInputResolver - Interface in org.rodnansol.core.generator.resolver
Interface representing methods that a new instance must implement if it wants to resolve spring-configuration-metadata.json files from different sources.
MetadataInputResolverContext - Class in org.rodnansol.core.generator.resolver
Class that uses different MetadataInputResolver instances to resolve the spring-configuration-metadata.json file from different inputs.
MetadataInputResolverContext() - Constructor for class org.rodnansol.core.generator.resolver.MetadataInputResolverContext
 
MetadataReader - Class in org.rodnansol.core.generator.reader
Reads the spring-configuration-metadata.json file.
modules - Variable in class org.rodnansol.core.project.Project
 

N

name - Variable in class org.rodnansol.core.project.Project
 

O

ofGradleProject(File, String) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a GradleProject instance with a basedir and the module's name.
ofGradleProject(File, String, List<String>) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a GradleProject instance with a basedir and the module's name with modules.
ofGroupFilter(List<PropertyGroup>, List<String>, List<String>) - Static method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
ofMainSection(String, List<PropertyGroup>) - Static method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
ofMavenProject(File, String) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a MavenProject instance with a basedir and the module's name.
ofMavenProject(File, String, List<String>) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a MavenProject instance with a basedir and the module's name with modules.
ofPropertyFilter(List<PropertyGroup>, List<String>, List<String>) - Static method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
ofSimpleProject(File, String) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a SimpleProject instance with a basedir and the module's name.
ofTemplate(TemplateCustomization, List<PropertyGroup>) - Static method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
ofType(File, String, ProjectType) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a Project instance with a basedir and the module's name based on the incoming project type.
ofTypeWithModules(File, String, List<String>, ProjectType) - Static method in class org.rodnansol.core.project.ProjectFactory
Creates a Project instance with a basedir and the module's name based and modules on the incoming project type.
org.rodnansol.core.action - package org.rodnansol.core.action
 
org.rodnansol.core.generator - package org.rodnansol.core.generator
 
org.rodnansol.core.generator.reader - package org.rodnansol.core.generator.reader
 
org.rodnansol.core.generator.resolver - package org.rodnansol.core.generator.resolver
 
org.rodnansol.core.generator.template - package org.rodnansol.core.generator.template
 
org.rodnansol.core.generator.template.compiler - package org.rodnansol.core.generator.template.compiler
 
org.rodnansol.core.generator.template.customization - package org.rodnansol.core.generator.template.customization
 
org.rodnansol.core.generator.template.data - package org.rodnansol.core.generator.template.data
 
org.rodnansol.core.generator.template.handlebars - package org.rodnansol.core.generator.template.handlebars
 
org.rodnansol.core.generator.writer - package org.rodnansol.core.generator.writer
 
org.rodnansol.core.generator.writer.postprocess - package org.rodnansol.core.generator.writer.postprocess
 
org.rodnansol.core.project - package org.rodnansol.core.project
 
org.rodnansol.core.project.gradle - package org.rodnansol.core.project.gradle
 
org.rodnansol.core.project.maven - package org.rodnansol.core.project.maven
 
org.rodnansol.core.project.simple - package org.rodnansol.core.project.simple
 
org.rodnansol.core.util - package org.rodnansol.core.util
 
org.springframework.boot.context.properties.source - package org.springframework.boot.context.properties.source
 

P

postProcessPropertyGroups(PostProcessPropertyGroupsCommand) - Method in class org.rodnansol.core.generator.writer.postprocess.PropertyGroupFilterService
Post process the incoming property groups with the different attributes.
PostProcessPropertyGroupsCommand - Class in org.rodnansol.core.generator.writer.postprocess
Class grouping attributes together that helps to post process the property groups and properties.
PostProcessPropertyGroupsCommand(TemplateCustomization, List<PropertyGroup>, List<String>, List<String>, List<String>, List<String>) - Constructor for class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
Project - Class in org.rodnansol.core.project
Class representing a project.
Project(File, String, ProjectType) - Constructor for class org.rodnansol.core.project.Project
 
ProjectFactory - Class in org.rodnansol.core.project
Class acting as a factory for the different project types.
projectType - Variable in class org.rodnansol.core.project.Project
 
ProjectType - Enum in org.rodnansol.core.project
Enum containing the possible project types.
Property - Class in org.rodnansol.core.generator.template.data
Class representing a property.
Property(String, String) - Constructor for class org.rodnansol.core.generator.template.data.Property
 
Property(String, String, String, String, String, PropertyDeprecation) - Constructor for class org.rodnansol.core.generator.template.data.Property
 
PropertyDeprecation - Class in org.rodnansol.core.generator.template.data
Class represnting a deprecation info.
PropertyDeprecation(String, String) - Constructor for class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
PropertyGroup - Class in org.rodnansol.core.generator.template.data
Class representing a property group.
PropertyGroup(String, String, String) - Constructor for class org.rodnansol.core.generator.template.data.PropertyGroup
 
PropertyGroup(String, String, String, List<Property>) - Constructor for class org.rodnansol.core.generator.template.data.PropertyGroup
 
PropertyGroupConstants - Class in org.rodnansol.core.generator.template.data
Class grouping constants together for the property groups.
PropertyGroupConstants() - Constructor for class org.rodnansol.core.generator.template.data.PropertyGroupConstants
 
PropertyGroupFilterService - Class in org.rodnansol.core.generator.writer.postprocess
Class that deals with the filtering of the property group lists.
PropertyGroupFilterService() - Constructor for class org.rodnansol.core.generator.writer.postprocess.PropertyGroupFilterService
 
PropertyGroupFilterService(List<PropertyGroupPostProcessor>) - Constructor for class org.rodnansol.core.generator.writer.postprocess.PropertyGroupFilterService
 

R

readMetadataAndGenerateRenderedFile(CreateDocumentCommand) - Method in class org.rodnansol.core.generator.writer.Documenter
Creates and writes a single document to disk based on the incoming command object.
readPropertiesAsMap(InputStream) - Method in class org.rodnansol.core.generator.reader.MetadataReader
Returns the properties in a map where the key is the name of the properties key and the values is the associated properties.
readPropertiesAsPropertyGroupList(InputStream) - Method in class org.rodnansol.core.generator.reader.MetadataReader
Returns a list of PropertyGroup instances from the given input stream.
removeEmptyGroups - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
If empty groups must be removed from the final document or not.
resetMemory() - Method in interface org.rodnansol.core.generator.template.compiler.TemplateCompilerMemoryStore
Resets the memory.
resetMemory() - Method in class org.rodnansol.core.generator.template.compiler.ThreadLocalTemplateCompilerStore
 
resolveInputStream(Project, File) - Method in interface org.rodnansol.core.generator.resolver.MetadataInputResolver
Resolves the metadata file from the given parameters.
RIGHT - org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
 

S

setBackgroundColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setCodeColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setCollapsibleHoverColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setContentCustomization(ContentCustomization) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setContentCustomization(ContentCustomization) - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Sets the template content customization.
setCustomContentTemplate(String) - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
setCustomFooterTemplate(String) - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
setCustomHeaderTemplate(String) - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
setCustomTemplate(CustomTemplate) - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
setDefaultValue(String) - Method in class org.rodnansol.core.generator.template.data.Property
 
setDescription(String) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setDescription(String) - Method in class org.rodnansol.core.generator.template.data.Property
 
setDescription(String) - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
setDescription(String) - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
setEvenTableRowColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setExcludedGroups(List<String>) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setExcludedGroups(List<String>) - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
setExcludedGroups(List<String>) - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
setExcludedProperties(List<String>) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setExcludedProperties(List<String>) - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
setExcludedProperties(List<String>) - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
setGenerationDate(LocalDateTime) - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
setGenerationDate(LocalDateTime) - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
setGroupName(String) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
setHeaderEnabled(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setIncludeClass(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeDefaultValue(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeDeprecation(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeDescription(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludedGroups(List<String>) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setIncludedGroups(List<String>) - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
setIncludedGroups(List<String>) - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
setIncludedProperties(List<String>) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setIncludedProperties(List<String>) - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
setIncludedProperties(List<String>) - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
 
setIncludeEnvFormat(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setIncludeEnvFormat(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeGenerationDate(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setIncludeKey(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeType(boolean) - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
setIncludeUnknownGroup(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setKey(String) - Method in class org.rodnansol.core.generator.template.data.Property
 
setLastTableRowColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setLinkColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setLocale(String) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setMainDescription(String) - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
setModuleDescription(String) - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
setModules(List<String>) - Method in class org.rodnansol.core.project.Project
 
setNested(boolean) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
setOutputFile(File) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setParentGroup(PropertyGroup) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
setProperties(List<Property>) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
setPropertyDeprecation(PropertyDeprecation) - Method in class org.rodnansol.core.generator.template.data.Property
 
setRemoveEmptyGroups(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setSubTemplateDataList(List<SubTemplateData>) - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
setTableOfContentsEnabled(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setTableRowBorderColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setTableRowColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setTemplate(String) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setTemplateCompilerName(String) - Method in class org.rodnansol.core.action.DocumentGenerationAction
 
setTemplateCustomization(TemplateCustomization) - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
setTemplateCustomization(TemplateCustomization) - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
setTemplateCustomization(TemplateCustomization) - Method in interface org.rodnansol.core.generator.template.data.TemplateData
Sets the template customization data.
setTemplateMode(TemplateMode) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setTemplateMode(TemplateMode) - Method in interface org.rodnansol.core.generator.template.customization.TemplateCustomization
Sets the template mode.
setTextColor(String) - Method in class org.rodnansol.core.generator.template.customization.HtmlTemplateCustomization
 
setTocLevels(int) - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
setTocPlacement(AsciiDocTemplateCustomization.TocPlacement) - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
setTocTitle(String) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
setUnknownGroup(boolean) - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
setUnknownGroupLocalization(String) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
SIMPLE - org.rodnansol.core.project.ProjectType
 
SimpleProject - Class in org.rodnansol.core.project.simple
Class representing a simple class.
SimpleProject(File, String) - Constructor for class org.rodnansol.core.project.simple.SimpleProject
 
STANDARD - org.rodnansol.core.generator.template.TemplateMode
This template mode has detailed information about the property groups and its properties.
SubTemplateData - Class in org.rodnansol.core.generator.template.data
Class representing a sub template data.
SubTemplateData(String, List<PropertyGroup>) - Constructor for class org.rodnansol.core.generator.template.data.SubTemplateData
 
supports(File) - Method in interface org.rodnansol.core.generator.resolver.MetadataInputResolver
Checks if the input resolver supports this input or not.
SystemEnvironmentPropertyMapperDelegator - Class in org.springframework.boot.context.properties.source
Delegate the transformation of a property to the Spring package private SystemEnvironmentPropertyMapper class.

T

tableOfContentsEnabled - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Should the "Table of Contents" enabled or not.
TEMPLATE_CUSTOMIZATION - Static variable in class org.rodnansol.core.generator.template.compiler.TemplateCompilerMemoryStoreConstants
Key representing the TemplateCustomization in the memory store.
TemplateCompiler - Interface in org.rodnansol.core.generator.template.compiler
Class that handles the template compiling.
TemplateCompilerFactory - Class in org.rodnansol.core.generator.template.compiler
Factory class that uses the ServiceLoader class to have dynamic implementations for the TemplateCompiler and make sure end users are able to customize it for their own taste.
TemplateCompilerMemoryStore - Interface in org.rodnansol.core.generator.template.compiler
Interface representing methods for an in-memory store.
TemplateCompilerMemoryStoreConstants - Class in org.rodnansol.core.generator.template.compiler
Class containts contants for the memory store.
TemplateCustomization - Interface in org.rodnansol.core.generator.template.customization
Class represents a template customization object.
TemplateCustomizationFactory - Class in org.rodnansol.core.generator.template.customization
Class representing a factory for the template customization objects.
TemplateData - Interface in org.rodnansol.core.generator.template.data
Interface representing the ancestor for all template data types.
templateMode - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Controls the template mode.
TemplateMode - Enum in org.rodnansol.core.generator.template
Enumeration collecting all the available template modes.
TemplateNotFoundException - Exception in org.rodnansol.core.generator.template
 
TemplateNotFoundException(String) - Constructor for exception org.rodnansol.core.generator.template.TemplateNotFoundException
 
TemplateResource - Class in org.rodnansol.core.generator.template
Class collecting all the necessary resources for the different TemplateTypes.
TemplateResource(String, String, String, String) - Constructor for class org.rodnansol.core.generator.template.TemplateResource
 
TemplateType - Enum in org.rodnansol.core.generator.template
 
ThreadLocalTemplateCompilerStore - Class in org.rodnansol.core.generator.template.compiler
ThreadLocal based TemplateCompilerMemoryStore.
tocTitle - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Table of Contents title.
toLowerCase() - Method in enum org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
 
toString() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
 
toString() - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
 
toString() - Method in class org.rodnansol.core.generator.template.customization.ContentCustomization
 
toString() - Method in class org.rodnansol.core.generator.template.data.MainTemplateData
 
toString() - Method in class org.rodnansol.core.generator.template.data.Property
 
toString() - Method in class org.rodnansol.core.generator.template.data.PropertyDeprecation
 
toString() - Method in class org.rodnansol.core.generator.template.data.PropertyGroup
 
toString() - Method in class org.rodnansol.core.generator.template.data.SubTemplateData
 
toString() - Method in class org.rodnansol.core.generator.writer.CombinedInput
 
toString() - Method in class org.rodnansol.core.generator.writer.CreateAggregationCommand
 
toString() - Method in class org.rodnansol.core.generator.writer.CustomTemplate
 
toString() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
 
toString() - Method in class org.rodnansol.core.project.Project
 

U

UNKNOWN - Static variable in class org.rodnansol.core.generator.template.data.PropertyGroupConstants
 
UNKNOWN_GROUP - Static variable in class org.rodnansol.core.generator.template.data.PropertyGroupConstants
 
unknownGroupLocalization - Variable in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
Returns the title for the unknown group.

V

valueOf(String) - Static method in enum org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.rodnansol.core.generator.template.TemplateMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.rodnansol.core.generator.template.TemplateType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.rodnansol.core.project.ProjectType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.rodnansol.core.generator.template.TemplateMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.rodnansol.core.generator.template.TemplateType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.rodnansol.core.project.ProjectType
Returns an array containing the constants of this enum type, in the order they are declared.

X

XML - org.rodnansol.core.generator.template.TemplateType
 
XmlTemplateCustomization - Class in org.rodnansol.core.generator.template.customization
Class representing XML template customizations.
XmlTemplateCustomization() - Constructor for class org.rodnansol.core.generator.template.customization.XmlTemplateCustomization
 
A B C D E G H I L M N O P R S T U V X 
All Classes All Packages