Package docet.maven

Class DocetPluginUtils

java.lang.Object

docet.maven.DocetPluginUtils

public final class DocetPluginUtils
extends java.lang.Object

Author:

matteo.casadei

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocetPluginUtils.Holder<T>
static class	DocetPluginUtils.Language

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FAQ_DEFAULT_PAGE_PREFIX
static java.lang.String	FAQ_HOME_ANCHOR_ID
static java.lang.String	FAQ_TOC_ID
static int	SHORT_SEARCH_ANSWER_TEXT_DEFAULT_LENGTH
static int	SHORT_SEARCH_TEXT_DEFAULT_LENGTH

Method Summary

Modifier and Type	Method	Description
static void	copyingDocs(java.nio.file.Path outDir, org.apache.maven.plugin.logging.Log log)
static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>>	generatePdfsForLanguage(java.nio.file.Path srcDir, java.nio.file.Path outDir, java.nio.file.Path tmpDir, java.lang.String langCode, org.apache.maven.plugin.logging.Log log)
static org.apache.tika.parser.AutoDetectParser	getTikaParser()
static void	indexDocs(java.nio.file.Path outDir, java.nio.file.Path srcDir, java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs, org.apache.maven.plugin.logging.Log log, boolean compact)
static int	indexDocsForLanguage(java.nio.file.Path outDir, java.nio.file.Path path, DocetPluginUtils.Language lang, java.util.List<FaqEntry> faqs, org.apache.maven.plugin.logging.Log log, boolean compact)
static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>>	validateDocs(java.nio.file.Path srcDir, java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs, org.apache.maven.plugin.logging.Log log)
static int	validateDocsForLanguage(java.nio.file.Path path, DocetPluginUtils.Language lang, java.util.List<FaqEntry> faqs, java.util.function.BiConsumer<Severity,java.lang.String> call, org.apache.maven.plugin.logging.Log log)
static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>>	validatePdfs(java.nio.file.Path srcDir, org.apache.maven.plugin.logging.Log log)
static int	validatePdfsForLanguage(java.nio.file.Path path, DocetPluginUtils.Language lang, java.util.function.BiConsumer<Severity,java.lang.String> call, org.apache.maven.plugin.logging.Log log)
static int	zippingDocs(java.nio.file.Path srcDir, java.nio.file.Path outDir, java.nio.file.Path indexDir, boolean includeIndex, java.nio.file.Path zipFileName, java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs, org.apache.maven.plugin.logging.Log log)

Methods inherited from class java.lang.Object

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

Field Detail

FAQ_DEFAULT_PAGE_PREFIX

public static final java.lang.String FAQ_DEFAULT_PAGE_PREFIX

See Also:

Constant Field Values

SHORT_SEARCH_TEXT_DEFAULT_LENGTH

public static final int SHORT_SEARCH_TEXT_DEFAULT_LENGTH

See Also:

Constant Field Values

SHORT_SEARCH_ANSWER_TEXT_DEFAULT_LENGTH

public static final int SHORT_SEARCH_ANSWER_TEXT_DEFAULT_LENGTH

See Also:

Constant Field Values

FAQ_TOC_ID

public static final java.lang.String FAQ_TOC_ID

See Also:

Constant Field Values

FAQ_HOME_ANCHOR_ID

public static final java.lang.String FAQ_HOME_ANCHOR_ID

See Also:

Constant Field Values

Method Detail

getTikaParser

public static org.apache.tika.parser.AutoDetectParser getTikaParser()

validateDocs

public static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>> validateDocs(java.nio.file.Path srcDir,
                                                                                                     java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs,
                                                                                                     org.apache.maven.plugin.logging.Log log)
                                                                                              throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

validatePdfs

public static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>> validatePdfs(java.nio.file.Path srcDir,
                                                                                                     org.apache.maven.plugin.logging.Log log)
                                                                                              throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

validatePdfsForLanguage

public static int validatePdfsForLanguage(java.nio.file.Path path,
                                          DocetPluginUtils.Language lang,
                                          java.util.function.BiConsumer<Severity,java.lang.String> call,
                                          org.apache.maven.plugin.logging.Log log)
                                   throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

validateDocsForLanguage

public static int validateDocsForLanguage(java.nio.file.Path path,
                                          DocetPluginUtils.Language lang,
                                          java.util.List<FaqEntry> faqs,
                                          java.util.function.BiConsumer<Severity,java.lang.String> call,
                                          org.apache.maven.plugin.logging.Log log)
                                   throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

copyingDocs

public static void copyingDocs(java.nio.file.Path outDir,
                               org.apache.maven.plugin.logging.Log log)

generatePdfsForLanguage

public static java.util.Map<DocetPluginUtils.Language,java.util.List<DocetIssue>> generatePdfsForLanguage(java.nio.file.Path srcDir,
                                                                                                                java.nio.file.Path outDir,
                                                                                                                java.nio.file.Path tmpDir,
                                                                                                                java.lang.String langCode,
                                                                                                                org.apache.maven.plugin.logging.Log log)
                                                                                                         throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

zippingDocs

public static int zippingDocs(java.nio.file.Path srcDir,
                              java.nio.file.Path outDir,
                              java.nio.file.Path indexDir,
                              boolean includeIndex,
                              java.nio.file.Path zipFileName,
                              java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs,
                              org.apache.maven.plugin.logging.Log log)
                       throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

indexDocs

public static void indexDocs(java.nio.file.Path outDir,
                             java.nio.file.Path srcDir,
                             java.util.Map<DocetPluginUtils.Language,java.util.List<FaqEntry>> faqs,
                             org.apache.maven.plugin.logging.Log log,
                             boolean compact)
                      throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

indexDocsForLanguage

public static int indexDocsForLanguage(java.nio.file.Path outDir,
                                       java.nio.file.Path path,
                                       DocetPluginUtils.Language lang,
                                       java.util.List<FaqEntry> faqs,
                                       org.apache.maven.plugin.logging.Log log,
                                       boolean compact)
                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException