com.mulesoft.documentation.builder.util

Class Utilities

java.lang.Object

com.mulesoft.documentation.builder.util.Utilities

public class Utilities
extends Object

Created by sean.osterberg on 2/20/15.

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Modifier and Type	Method and Description
static String	cleanPageFileNames(String originalFilename)
static boolean	deleteTargetDirectory(String directoryName)
static boolean	directoryContainsAsciiDocFile(File directory)
static boolean	directoryContainsTocFile(File directory)
static boolean	directoryContainsVersions(File directory)
static boolean	fileEndsWithValidAsciidocExtension(String fileName)
static String	fixIndexBaseName(String baseName)
static String	getConcatPath(String[] filesOrDirectoriesToAppend)
static String	getFileContentsFromFile(File file)
static List<String>	getFileContentsFromFiles(List<File> files)
static String	getOnlyContentDivFromHtml(String html)
static String	getRandomAlphaNumericString(int length)
static boolean	isActiveUrlInSection(TocNode parentNode, String activeUrl, boolean isInSection)
static boolean	makeTargetDirectory(String directoryPath)
static String	removeLeadingSlashes(String s)
static StringBuilder	replaceText(StringBuilder original, String toReplace, String replacement)
static void	validateAsciiDocFile(File asciiDocFile)
static void	validateCtorObjectsAreNotNull(Object[] params, String className)
static void	validateCtorStringInputParam(String[] params, String className)
static void	validateDirectoryContainsAsciiDocFile(File directory)
static void	validateDirectoryContainsTocFile(File directory)
static void	validateFileExists(File file)
static void	validateIfActiveUrlIsInSection(TocNode root, String activeUrl)
static void	validateIsDirectory(File directory)
static void	validateMasterDirectory(File masterDirectory)
static void	validatePrettyNameExists(File directory)
static void	validateTemplateFile(File templateFile)
static void	writeFileToDirectory(String filePath, String fileContents)

Methods inherited from class java.lang.Object

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

Constructor Detail

Utilities

public Utilities()

Method Detail

getFileContentsFromFile

public static String getFileContentsFromFile(File file)

getFileContentsFromFiles

public static List<String> getFileContentsFromFiles(List<File> files)

fileEndsWithValidAsciidocExtension

public static boolean fileEndsWithValidAsciidocExtension(String fileName)

validateAsciiDocFile

public static void validateAsciiDocFile(File asciiDocFile)

getConcatPath

public static String getConcatPath(String[] filesOrDirectoriesToAppend)

removeLeadingSlashes

public static String removeLeadingSlashes(String s)

replaceText

public static StringBuilder replaceText(StringBuilder original,
                                        String toReplace,
                                        String replacement)

getOnlyContentDivFromHtml

public static String getOnlyContentDivFromHtml(String html)

validateCtorStringInputParam

public static void validateCtorStringInputParam(String[] params,
                                                String className)

cleanPageFileNames

public static String cleanPageFileNames(String originalFilename)

validateCtorObjectsAreNotNull

public static void validateCtorObjectsAreNotNull(Object[] params,
                                                 String className)

getRandomAlphaNumericString

public static String getRandomAlphaNumericString(int length)

isActiveUrlInSection

public static boolean isActiveUrlInSection(TocNode parentNode,
                                           String activeUrl,
                                           boolean isInSection)

validateIfActiveUrlIsInSection

public static void validateIfActiveUrlIsInSection(TocNode root,
                                                  String activeUrl)

validateFileExists

public static void validateFileExists(File file)

validateIsDirectory

public static void validateIsDirectory(File directory)

directoryContainsAsciiDocFile

public static boolean directoryContainsAsciiDocFile(File directory)

validateDirectoryContainsAsciiDocFile

public static void validateDirectoryContainsAsciiDocFile(File directory)

directoryContainsTocFile

public static boolean directoryContainsTocFile(File directory)

validateDirectoryContainsTocFile

public static void validateDirectoryContainsTocFile(File directory)

validatePrettyNameExists

public static void validatePrettyNameExists(File directory)

directoryContainsVersions

public static boolean directoryContainsVersions(File directory)

validateMasterDirectory

public static void validateMasterDirectory(File masterDirectory)

validateTemplateFile

public static void validateTemplateFile(File templateFile)

makeTargetDirectory

public static boolean makeTargetDirectory(String directoryPath)

deleteTargetDirectory

public static boolean deleteTargetDirectory(String directoryName)

writeFileToDirectory

public static void writeFileToDirectory(String filePath,
                                        String fileContents)

fixIndexBaseName

public static String fixIndexBaseName(String baseName)