Index (Spring Configuration Property Documenter

A B C D E G H I L M N O P R S T U V W 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.PropertyGroup: Add a new child group.
addProperty(Property) - Method in class org.rodnansol.core.generator.template.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
apply(String, Options) - Method in class org.rodnansol.core.generator.template.handlebars.EnvironmentVariableHelper
apply(TemplateData, Options) - Method in class org.rodnansol.core.generator.template.handlebars.IncludeEnvironmentVariableFormatHelper
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) - Constructor for class org.rodnansol.core.generator.writer.CombinedInput
compileTemplate(String, TemplateData) - Method in class org.rodnansol.core.generator.template.HandlebarsTemplateCompiler
compileTemplate(String, TemplateData) - Method in interface org.rodnansol.core.generator.template.TemplateCompiler: Compiles the template with the given template data.
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.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

EnvironmentVariableHelper - Class in org.rodnansol.core.generator.template.handlebars: Handlebars helpers transforming property to ENV_VARIABLE
EnvironmentVariableHelper() - Constructor for class org.rodnansol.core.generator.template.handlebars.EnvironmentVariableHelper
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.MainTemplateData
equals(Object) - Method in class org.rodnansol.core.generator.template.Property
equals(Object) - Method in class org.rodnansol.core.generator.template.PropertyDeprecation
equals(Object) - Method in class org.rodnansol.core.generator.template.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
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.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
getContentTemplate() - Method in enum org.rodnansol.core.generator.template.TemplateType
getCurrentWorkingDirectory() - Method in class org.rodnansol.core.generator.template.handlebars.WorkingDirectoryProvider: Returns the current working directory.
getCurrentWorkingDirectoryPath() - Method in class org.rodnansol.core.generator.template.handlebars.WorkingDirectoryProvider
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.
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).
getDefaultProvidedInstance() - Static method in class org.rodnansol.core.generator.template.TemplateCompilerFactory: Returns the default provided instance which is the HandlebarsTemplateCompiler.
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
getDefaultValue() - Method in class org.rodnansol.core.generator.template.Property
getDescription() - Method in class org.rodnansol.core.generator.template.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 enum org.rodnansol.core.generator.template.TemplateType
getFqName() - Method in class org.rodnansol.core.generator.template.Property
getGenerationDate() - Method in class org.rodnansol.core.generator.template.MainTemplateData
getGenerationDate() - Method in class org.rodnansol.core.generator.template.SubTemplateData
getGroupName() - Method in class org.rodnansol.core.generator.template.PropertyGroup
getHeaderTemplate() - 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.TemplateCompilerFactory: Returns a TemplateCompiler instance by its class name.
getInstanceByClassName(String) - Static method in class org.rodnansol.core.generator.template.TemplateCompilerFactory: Instantiates the incoming class by its name.
getKey() - Method in class org.rodnansol.core.generator.template.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.MainTemplateData
getMainName() - Method in class org.rodnansol.core.generator.template.MainTemplateData
getMetadataInput() - Method in class org.rodnansol.core.generator.writer.CreateDocumentCommand
getModuleDescription() - Method in class org.rodnansol.core.generator.template.SubTemplateData
getModuleName() - Method in class org.rodnansol.core.generator.template.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.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.PropertyGroup
getPropertyDeprecation() - Method in class org.rodnansol.core.generator.template.Property
getPropertyGroups() - Method in class org.rodnansol.core.generator.template.MainTemplateData
getPropertyGroups() - Method in class org.rodnansol.core.generator.template.SubTemplateData
getPropertyGroups() - Method in class org.rodnansol.core.generator.writer.postprocess.PostProcessPropertyGroupsCommand
getReason() - Method in class org.rodnansol.core.generator.template.PropertyDeprecation
getReplacement() - Method in class org.rodnansol.core.generator.template.PropertyDeprecation
getResource(String) - Method in class org.rodnansol.core.generator.template.handlebars.WorkingDirectoryAwareRecursiveFileTemplateLoader
getSectionName() - Method in class org.rodnansol.core.generator.writer.CombinedInput
getSingleTemplate() - Method in enum org.rodnansol.core.generator.template.TemplateType
getSourceType() - Method in class org.rodnansol.core.generator.template.PropertyGroup
getSubTemplateDataList() - Method in class org.rodnansol.core.generator.template.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.MainTemplateData
getTemplateCustomization() - Method in class org.rodnansol.core.generator.template.SubTemplateData
getTemplateCustomization() - Method in interface org.rodnansol.core.generator.template.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
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.Property
getType() - Method in class org.rodnansol.core.generator.template.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: Template compiler implementation that uses Handlebarsto compile a template.
HandlebarsTemplateCompiler() - Constructor for class org.rodnansol.core.generator.template.HandlebarsTemplateCompiler
HandlebarsTemplateCompiler(Handlebars) - Constructor for class org.rodnansol.core.generator.template.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.MainTemplateData
hashCode() - Method in class org.rodnansol.core.generator.template.Property
hashCode() - Method in class org.rodnansol.core.generator.template.PropertyDeprecation
hashCode() - Method in class org.rodnansol.core.generator.template.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: If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
IncludeEnvironmentVariableFormatHelper - Class in org.rodnansol.core.generator.template.handlebars: Helper class to determine whether to include the enviroment variable format or not.
IncludeEnvironmentVariableFormatHelper() - Constructor for class org.rodnansol.core.generator.template.handlebars.IncludeEnvironmentVariableFormatHelper
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.handlebars.WorkingDirectoryProvider
INSTANCE - Static variable in class org.rodnansol.core.generator.writer.postprocess.PropertyGroupFilterService
isHeaderEnabled() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
isIncludeEnvFormat() - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
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.
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.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.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.

M

MainTemplateData - Class in org.rodnansol.core.generator.template: Class representing the main template data.
MainTemplateData(String, List<PropertyGroup>) - Constructor for class org.rodnansol.core.generator.template.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.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.customization - package org.rodnansol.core.generator.template.customization
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: Class representing a property.
Property(String, String) - Constructor for class org.rodnansol.core.generator.template.Property
Property(String, String, String, String, String, PropertyDeprecation) - Constructor for class org.rodnansol.core.generator.template.Property
PropertyDeprecation - Class in org.rodnansol.core.generator.template: Class represnting a deprecation info.
PropertyDeprecation(String, String) - Constructor for class org.rodnansol.core.generator.template.PropertyDeprecation
PropertyGroup - Class in org.rodnansol.core.generator.template: Class representing a property group.
PropertyGroup(String, String, String) - Constructor for class org.rodnansol.core.generator.template.PropertyGroup
PropertyGroup(String, String, String, List<Property>) - Constructor for class org.rodnansol.core.generator.template.PropertyGroup
PropertyGroupConstants - Class in org.rodnansol.core.generator.template: Class grouping constants together for the property groups.
PropertyGroupConstants() - Constructor for class org.rodnansol.core.generator.template.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.
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
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.Property
setDescription(String) - Method in class org.rodnansol.core.action.DocumentGenerationAction
setDescription(String) - Method in class org.rodnansol.core.generator.template.Property
setDescription(String) - Method in class org.rodnansol.core.generator.writer.CombinedInput
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.MainTemplateData
setGenerationDate(LocalDateTime) - Method in class org.rodnansol.core.generator.template.SubTemplateData
setGroupName(String) - Method in class org.rodnansol.core.generator.template.PropertyGroup
setHeaderEnabled(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
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
setIncludeGenerationDate(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
setIncludeUnknownGroup(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
setKey(String) - Method in class org.rodnansol.core.generator.template.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.MainTemplateData
setModuleDescription(String) - Method in class org.rodnansol.core.generator.template.SubTemplateData
setModules(List<String>) - Method in class org.rodnansol.core.project.Project
setNested(boolean) - Method in class org.rodnansol.core.generator.template.PropertyGroup
setOutputFile(File) - Method in class org.rodnansol.core.action.DocumentGenerationAction
setParentGroup(PropertyGroup) - Method in class org.rodnansol.core.generator.template.PropertyGroup
setProperties(List<Property>) - Method in class org.rodnansol.core.generator.template.PropertyGroup
setPropertyDeprecation(PropertyDeprecation) - Method in class org.rodnansol.core.generator.template.Property
setRemoveEmptyGroups(boolean) - Method in class org.rodnansol.core.generator.template.customization.AbstractTemplateCustomization
setSubTemplateDataList(List<SubTemplateData>) - Method in class org.rodnansol.core.generator.template.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.MainTemplateData
setTemplateCustomization(TemplateCustomization) - Method in class org.rodnansol.core.generator.template.SubTemplateData
setTemplateCustomization(TemplateCustomization) - Method in interface org.rodnansol.core.generator.template.TemplateData: Sets the template customization data.
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.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
SubTemplateData - Class in org.rodnansol.core.generator.template: Class representing a sub template data.
SubTemplateData(String, List<PropertyGroup>) - Constructor for class org.rodnansol.core.generator.template.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.
TemplateCompiler - Interface in org.rodnansol.core.generator.template: Class that handles the template compiling.
TemplateCompilerFactory - Class in org.rodnansol.core.generator.template: 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.
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.
TemplateCustomizationFactory() - Constructor for class org.rodnansol.core.generator.template.customization.TemplateCustomizationFactory
TemplateData - Interface in org.rodnansol.core.generator.template: Interface representing the ancestor for all template data types.
TemplateType - Enum in org.rodnansol.core.generator.template
toLowerCase() - Method in enum org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization.TocPlacement
toString() - Method in class org.rodnansol.core.generator.template.customization.AsciiDocTemplateCustomization
toString() - Method in class org.rodnansol.core.generator.template.MainTemplateData
toString() - Method in class org.rodnansol.core.generator.template.Property
toString() - Method in class org.rodnansol.core.generator.template.PropertyDeprecation
toString() - Method in class org.rodnansol.core.generator.template.PropertyGroup
toString() - Method in class org.rodnansol.core.generator.template.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.PropertyGroupConstants
UNKNOWN_GROUP - Static variable in class org.rodnansol.core.generator.template.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.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.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.

W

WorkingDirectoryAwareRecursiveFileTemplateLoader - Class in org.rodnansol.core.generator.template.handlebars: This FileTemplateLoader implementation is able to find recursively a template file by it's location.
WorkingDirectoryAwareRecursiveFileTemplateLoader(String, String, WorkingDirectoryProvider) - Constructor for class org.rodnansol.core.generator.template.handlebars.WorkingDirectoryAwareRecursiveFileTemplateLoader
WorkingDirectoryAwareRecursiveFileTemplateLoader(String, WorkingDirectoryProvider) - Constructor for class org.rodnansol.core.generator.template.handlebars.WorkingDirectoryAwareRecursiveFileTemplateLoader
WorkingDirectoryProvider - Class in org.rodnansol.core.generator.template.handlebars: Class that is able to return the current working directory.

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 W X
All Classes All Packages