com.credibledoc.substitution.doc

Class SubstitutionDocMain

java.lang.Object

com.credibledoc.substitution.doc.SubstitutionDocMain

@ComponentScan(basePackages="com.credibledoc.substitution.doc")
public class SubstitutionDocMain
extends Object

The main class for generation of documentation of the credibledoc-substitution tool.

This main method should be launched in the credible-doc\substitution (parent) working directory.

Author:

Kyrylo Semenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_SUBSTITUTION_DOC_FINISHED
static String	APPLICATION_SUBSTITUTION_DOC_LAUNCHED
private static org.slf4j.Logger	log
private List<ReportDocumentCreator>	reportDocumentCreators
static String	SUBSTITUTION_DOC
private SubstitutionTactic	substitutionSpecificTactic

Constructor Summary

Constructors

Constructor and Description
SubstitutionDocMain(List<ReportDocumentCreator> reportDocumentCreators, SubstitutionTactic substitutionSpecificTactic)

Method Summary

Modifier and Type	Method and Description
private boolean	containsDotInName(String resource)
private void	copyResourcesToTargetDirectory()
static void	main(String[] args) The main method for generation of documentation of the credibledoc-substitution tool.
private void	substitute()

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

APPLICATION_SUBSTITUTION_DOC_LAUNCHED

public static final String APPLICATION_SUBSTITUTION_DOC_LAUNCHED

See Also:

Constant Field Values

SUBSTITUTION_DOC

public static final String SUBSTITUTION_DOC

See Also:

Constant Field Values

APPLICATION_SUBSTITUTION_DOC_FINISHED

public static final String APPLICATION_SUBSTITUTION_DOC_FINISHED

See Also:

Constant Field Values

reportDocumentCreators

@NonNull
private final List<ReportDocumentCreator> reportDocumentCreators

substitutionSpecificTactic

@NonNull
private final SubstitutionTactic substitutionSpecificTactic

Constructor Detail

SubstitutionDocMain

@Inject
public SubstitutionDocMain(@NonNull
                                    List<ReportDocumentCreator> reportDocumentCreators,
                                    @NonNull
                                    SubstitutionTactic substitutionSpecificTactic)

Method Detail

main

public static void main(String[] args)

The main method for generation of documentation of the credibledoc-substitution tool.

This method should be launched within its parent (../substitution) folder.

Parameters:

args - not used

substitute

private void substitute()

copyResourcesToTargetDirectory

private void copyResourcesToTargetDirectory()

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