com.credibledoc.substitution.reporting.replacement

Class ReplacementService

java.lang.Object

com.credibledoc.substitution.reporting.replacement.ReplacementService

public class ReplacementService
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_REPLACED
private static ReplacementService	instance Singleton.
private static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ReplacementService()

Method Summary

Modifier and Type	Method and Description
private boolean	containsDotInName(String resource)
List<TemplateResource>	copyResourcesToTargetDirectory(SubstitutionContext substitutionContext)
private void	createDirectoryIfNotExists(File directory)
private String	findPlaceholderAndGenerateDiagram(Placeholder placeholder, SubstitutionContext substitutionContext)
private String	generateContent(Placeholder placeholder, SubstitutionContext substitutionContext) Depends on Placeholder.getClassName() use its instance for generation of placeholder content and replace it.
static ReplacementService	getInstance()
File	getTargetFile(TemplateResource templateResource, SubstitutionContext substitutionContext)
void	insertContentIntoTemplate(TemplateResource templateResource, SubstitutionContext substitutionContext) Load template from the TemplateResource, collect Placeholders from the template, replace the Placeholders with generated content and write the template with generated content to a target file.
private String	processContentGenerator(Placeholder placeholder, SubstitutionContext substitutionContext, Class<? extends ContentGenerator> placeholderClass)
void	replace(SubstitutionContext substitutionContext) Call the copyResourcesToTargetDirectory(SubstitutionContext) method and then for every TemplateResource call the insertContentIntoTemplate(TemplateResource, SubstitutionContext) method.
private String	replaceContent(TemplateResource templateResource, List<String> templatePlaceholders, SubstitutionContext substitutionContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final org.slf4j.Logger logger

CONTENT_REPLACED

public static final String CONTENT_REPLACED

See Also:

Constant Field Values

instance

private static final ReplacementService instance

Singleton.

Constructor Detail

ReplacementService

public ReplacementService()

Method Detail

getInstance

public static ReplacementService getInstance()

Returns:

The ReplacementService singleton.

insertContentIntoTemplate

public void insertContentIntoTemplate(TemplateResource templateResource,
                                      SubstitutionContext substitutionContext)

Load template from the TemplateResource, collect Placeholders from the template, replace the Placeholders with generated content and write the template with generated content to a target file.

Parameters:

templateResource - source of a template, for example /template/markdown/doc/diagrams.md

substitutionContext - the current state

getTargetFile

public File getTargetFile(TemplateResource templateResource,
                          SubstitutionContext substitutionContext)

replaceContent

private String replaceContent(TemplateResource templateResource,
                              List<String> templatePlaceholders,
                              SubstitutionContext substitutionContext)

generateContent

private String generateContent(Placeholder placeholder,
                               SubstitutionContext substitutionContext)

Depends on Placeholder.getClassName() use its instance for generation of placeholder content and replace it.

Parameters:

placeholder - contains a Placeholder.getClassName()

substitutionContext - the current state

Returns:

in case of ReportDocumentCreator return for example

![Diagram generated by this application](img/launching.md_1.svg?sanitize=true)

tag.

In case of ContentGenerator return a generated content.

processContentGenerator

private String processContentGenerator(Placeholder placeholder,
                                       SubstitutionContext substitutionContext,
                                       Class<? extends ContentGenerator> placeholderClass)

findPlaceholderAndGenerateDiagram

private String findPlaceholderAndGenerateDiagram(Placeholder placeholder,
                                                 SubstitutionContext substitutionContext)

createDirectoryIfNotExists

private void createDirectoryIfNotExists(File directory)

replace

public void replace(SubstitutionContext substitutionContext)

Call the copyResourcesToTargetDirectory(SubstitutionContext) method and then for every TemplateResource call the insertContentIntoTemplate(TemplateResource, SubstitutionContext) method.

Parameters:

substitutionContext - the current state.

copyResourcesToTargetDirectory

public List<TemplateResource> copyResourcesToTargetDirectory(SubstitutionContext substitutionContext)

containsDotInName

private boolean containsDotInName(String resource)

Parameters:

resource - for example '/template/markdown/' is a directory, and '/template/markdown/README.md' is a file.

Returns:

'False' if this resource is directory