org.digitalmediaserver.crowdin.tool

Class FileUtil

java.lang.Object

org.digitalmediaserver.crowdin.tool.FileUtil

public class FileUtil
extends Object

A utility class containing file related routines.

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileUtil.LetterCase An enum representing letter cases.

Method Summary

Methods

Modifier and Type	Method and Description
static String	appendPathSeparator(String path) Appends a path separator of the same type at the last position in the specified path if it's not already there, or / if there are none, unless the path is blank.
static String	formatPath(Path path, boolean appendSeparator) Formats a Path by converting backslashes to slashes and optionally appends a slash to the end of the Path.
static String	formatPath(String path, boolean appendSeparator) Formats a file path by converting backslashes to slashes and optionally appends a slash to the end of the path if it's not already present.
static String	getExtension(String fileName, FileUtil.LetterCase convertTo, Locale locale) Returns the file extension from fileName or null if fileName has no extension.
static int	getExtensionIndex(String filePath) Finds the index of the "extension dot" in the specified string.
static String	getPushFolder(TranslationFileSet fileSet, boolean includeCrowdinPath) Determines and returns the push file folder by taking TranslationFileSet.crowdinPath (optionally) and any folders in TranslationFileSet.baseFileName into account.
static List<String>	splitPath(String path, boolean omitFilename) Splits a file path into its elements, optionally omitting the filename (whatever is after the last separator) if there is one.

Methods inherited from class java.lang.Object

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

Method Detail

splitPath

@Nonnull
public static List<String> splitPath(@Nullable
                             String path,
                             boolean omitFilename)

Splits a file path into its elements, optionally omitting the filename (whatever is after the last separator) if there is one.

Parameters:

path - the file path to split.

omitFilename - whether or not to omit the last "element" (after the last separator).

Returns:

The List of folder elements.

getExtension

@Nullable
public static String getExtension(@Nullable
                           String fileName,
                           @Nullable
                           FileUtil.LetterCase convertTo,
                           @Nullable
                           Locale locale)

Returns the file extension from fileName or null if fileName has no extension.

Parameters:

fileName - the file name from which to extract the extension.

convertTo - if null makes no letter case change to the returned String, otherwise converts the extracted extension (if any) to the corresponding letter case.

locale - the Locale to use for letter case conversion. Defaults to Locale.ROOT if null.

Returns:

The extracted and potentially letter case converted extension or null.

getExtensionIndex

public static int getExtensionIndex(@Nullable
                    String filePath)

Finds the index of the "extension dot" in the specified string. This is the last . in the string that is not the last character and that comes after the last separator.

Parameters:

filePath - the file path to process.

Returns:

The index of the extension . or -1 if none could be found.

appendPathSeparator

@Nullable
public static String appendPathSeparator(@Nullable
                                  String path)

Appends a path separator of the same type at the last position in the specified path if it's not already there, or / if there are none, unless the path is blank.

Parameters:

path - the path to be modified.

Returns:

The corrected path or null if path is null.

formatPath

@Nullable
public static String formatPath(@Nullable
                         Path path,
                         boolean appendSeparator)

Formats a Path by converting backslashes to slashes and optionally appends a slash to the end of the Path.

Parameters:

path - the Path to format.

appendSeparator - if true a slash will be appended to the Path.

Returns:

The formatted file path or null if path was null.

formatPath

@Nullable
public static String formatPath(@Nullable
                         String path,
                         boolean appendSeparator)

Formats a file path by converting backslashes to slashes and optionally appends a slash to the end of the path if it's not already present.

Parameters:

path - the file path to format.

appendSeparator - if true a slash will be appended to the path if one isn't already there.

Returns:

The formatted file path or null if path was null.

getPushFolder

@Nonnull
public static String getPushFolder(@Nonnull
                           TranslationFileSet fileSet,
                           boolean includeCrowdinPath)

Determines and returns the push file folder by taking TranslationFileSet.crowdinPath (optionally) and any folders in TranslationFileSet.baseFileName into account. The resulting path will use / as a separator and will end with a separator if it has at least one element.

Parameters:

fileSet - the TranslationFileSet for which to find the Crowdin push folder.

includeCrowdinPath - true to include TranslationFileSet.crowdinPath in the returned path, false otherwise.

Returns:

The Crowdin push folder path or an empty string if the TranslationFileSet is placed in the Crowdin root.