com.arcway.cockpit.docgen.provider.interfaces

Interface IFileHelper

public interface IFileHelper

The IFileHelper provides access methods used for handling files for document generation. The IFileHelper can be referenced directly within a document template by its name fileHelper.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addExtensionIfMissing(java.lang.String fileName, java.lang.String extension) Adds a certain file extension, if none is existing.
java.lang.String	convertStringToPortableFileName(java.lang.String string) Replaces all invalid characters in a file name by underscores
boolean	copyDirectoryContent(java.lang.String srcDirectoryName, java.lang.String trgtDirectoryName) copies a directory's content into another directory
boolean	copyFile(java.lang.String sourceName, java.lang.String destinationName) copies a file from source to destination
java.lang.String	createPostProcessingFile(java.lang.String fileName) Creates a file name.
IRecord	decodeRecordFromXMLFile(java.lang.String fileNameOfFileToBeRead) Decodes a record from an XML file.
IRecord	decodeRecordFromXMLString(java.lang.String xmlString, java.lang.String encoding) Decodes a record from an XML String.
boolean	deleteContentOfDirectory(java.lang.String directoryName) deletes the content of the directory but not the directory itself
boolean	deleteExistingFileOrDirectory(java.lang.String fileOrDirectoryName) Deletes - a File or - a Directory and its contents (recursively)
boolean	deleteFileOrDirectory(java.lang.String fileOrDirectoryName) Deletes - a File or - a Directory and its contents (recursively) if it exists.
boolean	doesDirectoryContainEssentialFiles(java.lang.String directoryName, boolean ignoreDirectoryEntries, boolean ignoreAuxiliaryFiles) Checks if a directory contains relevant files.
java.lang.String	encodeRecordIntoPreprocessingXMLFile(IRecord record, java.lang.String rootName, java.lang.String namespace, java.lang.String encoding, boolean formatOutput) Encodes a record into a temporary XML file.
java.lang.String	encodeRecordIntoXMLString(IRecord record, java.lang.String rootName, java.lang.String namespace, java.lang.String encoding, boolean formatOutput) Encodes a record into an XML String.
boolean	ensureDirectoryExistance(java.lang.String directoryName) ensureDirectoryExisitance
java.lang.String	getChild(java.lang.String parentFileName, java.lang.String childName) Creates a filename from a parent pathname string and a child pathname string.
java.lang.String	getFileExtension(java.lang.String fileName) Extracts the file extension from the given file name.
java.lang.String	getFileNameWithoutPath(java.lang.String fileName) Returns the name of the file or directory denoted by an abstract pathname.
java.lang.String	getParent(java.lang.String fileName) Returns the pathname string of the parent, or null if the pathname does not name a parent directory.
boolean	isDirectory(java.lang.String fileName) Tests whether the file denoted by this abstract pathname is a directory.
boolean	isFile(java.lang.String fileName) Tests whether the file denoted by this abstract pathname is a normal file.
boolean	isHidden(java.lang.String fileName) Tests whether the file named by this abstract pathname is a hidden file.
long	lastModified(java.lang.String fileName) Returns the time that the file denoted by this abstract pathname was last modified.
long	length(java.lang.String fileName) Returns the length of the file denoted by this abstract pathname.
java.util.Collection<java.lang.String>	listDirectoryContent(java.lang.String directory) Returns the names of all files and folders of a certain directory.
IRecord	loadXMLFileIntoRecord(java.lang.String fileNameOfFileToBeRead) Loads an XML file into a record.
IRecord	loadXMLFileIntoRecord(java.lang.String xmlString, java.lang.String encoding) Loads an XML file (represented as string) into a record.
boolean	moveFile(java.lang.String sourceFileName, java.lang.String destinationFileName) moves a file from source to destination The destination file is deleted if it already exists.
java.util.List<java.lang.String>	readFileIntoBase64StringList(java.lang.String fileName, boolean breakLines) Returns the content of a file as string list (Base64 encoded).
java.util.List<java.lang.String>	readFileIntoStringList(java.lang.String fileName, java.lang.String characterEncoding) Returns the content of a file as string list.
IImageInfo	readImageInfo(java.lang.String imagefileName) Returns meta information regarding a certain image file.
java.lang.String	saveXMLFileFromRecordIntoPreprocessingXMLFile(IRecord record, java.lang.String fileNamePrefix, java.lang.String encoding, int formatOutput) Stores an XML file as contained in a record into a temporary XML file.
java.lang.String	saveXMLFileFromRecordIntoXMLString(IRecord record, java.lang.String encoding, int formatOutput) Stores an XML file as contained in a record into a XML String.
boolean	setLastModified(java.lang.String fileName, long time) Sets the last-modified time of the file or directory named by this abstract pathname.
boolean	setReadOnly(java.lang.String fileName) Marks the file or directory named by this abstract pathname so that only read operations are allowed.
java.lang.String	shortenFileName(java.lang.String fileName, int maxLength) Shortens the name to the specidfied maximum length while preserving the file extension.
java.lang.String	writeBase64IntoPostProcessingFile(java.util.List<java.lang.String> base64FileContent, java.lang.String originalFileName) Writes a base64 encoded content into the report as an embedded file.
java.lang.String	writeBase64IntoPostProcessingFile(java.util.List<java.lang.String> base64FileContent, java.lang.String originalFileName, double width_mm, double height_mm) Writes a base64 encoded content into the report as an embedded file.
java.lang.String	writeBase64IntoPreProcessingFile(java.util.List<java.lang.String> base64FileContent, java.lang.String prefix, java.lang.String extension) Writes a base64 encoded content into a temporary file.
java.lang.String	writeDecoratedImage(java.lang.String fileNameOfImageToDecorate, double toGray, java.lang.String fileNameOfDecoratorImage) Writes an image into the report as an embedded file.
java.lang.String	writeDecoratedImage(java.lang.String fileNameOfImageToDecorate, double toGray, java.lang.String fileNameOfDecoratorImage, double width_mm, double height_mm) Writes an image into the report as an embedded file.
java.lang.String	writeDecoratedImageAligned(java.lang.String fileNameOfImageToDecorate, double toGray, int baseAlignX, int baseAlignY, java.lang.String fileNameOfDecoratorImage, int alignX, int alignY, int offX, int offY) Writes an image into the report as an embedded file.
java.lang.String	writeDecoratedImageAligned(java.lang.String fileNameOfImageToDecorate, double toGray, int baseAlignX, int baseAlignY, java.lang.String fileNameOfDecoratorImage, int alignX, int alignY, int offX, int offY, double width_mm, double height_mm) Writes an image into the report as an embedded file.
java.lang.String	writeDecoratedImageAlignedIntoPreProcessingFile(java.lang.String fileNameOfImageToDecorate, double toGray, int baseAlignX, int baseAlignY, java.lang.String fileNameOfDecoratorImage, int alignX, int alignY, int offX, int offY) Writes an image into into a temporary file.
java.lang.String	writeStringListIntoPreProcessingFile(java.util.List<java.lang.String> stringList, java.lang.String prefix, java.lang.String extension, java.lang.String characterEncoding, boolean addCR, boolean addLF) Writes a string array into a temporary file.

Method Detail

readFileIntoStringList

java.util.List<java.lang.String> readFileIntoStringList(java.lang.String fileName,
                                                        java.lang.String characterEncoding)

Returns the content of a file as string list.

Parameters:

fileName - file name

characterEncoding - the encoding to be used when reading the file

Returns:

the file content (one entry per line)

writeStringListIntoPreProcessingFile

java.lang.String writeStringListIntoPreProcessingFile(java.util.List<java.lang.String> stringList,
                                                      java.lang.String prefix,
                                                      java.lang.String extension,
                                                      java.lang.String characterEncoding,
                                                      boolean addCR,
                                                      boolean addLF)
                                               throws java.io.IOException

Writes a string array into a temporary file.

The file is created a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

stringList - file content

prefix - file name prefix

extension - file extension

characterEncoding - character encoding

addCR - add CR after each line

addLF - add LF after each line

Returns:

the local file name that contains a given text.

Throws:

java.io.IOException

writeBase64IntoPreProcessingFile

java.lang.String writeBase64IntoPreProcessingFile(java.util.List<java.lang.String> base64FileContent,
                                                  java.lang.String prefix,
                                                  java.lang.String extension)
                                           throws java.io.IOException

Writes a base64 encoded content into a temporary file.

The file is created a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

stringList - file content

prefix - file name prefix

extension - file extension

Returns:

the local file name that contains a given text.

Throws:

java.io.IOException

readFileIntoBase64StringList

java.util.List<java.lang.String> readFileIntoBase64StringList(java.lang.String fileName,
                                                              boolean breakLines)

Returns the content of a file as string list (Base64 encoded).

Parameters:

fileName - file name

fileName - the local file name

Returns:

the file content (Base64 encoded)

readImageInfo

IImageInfo readImageInfo(java.lang.String imagefileName)

Returns meta information regarding a certain image file.

Parameters:

imagefileName - the image file name

Returns:

image info

writeBase64IntoPostProcessingFile

java.lang.String writeBase64IntoPostProcessingFile(java.util.List<java.lang.String> base64FileContent,
                                                   java.lang.String originalFileName)
                                            throws java.io.IOException

Writes a base64 encoded content into the report as an embedded file.

The file could be embedded in the target output.

Parameters:

stringList - file content

originalFileName - original file name

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeBase64IntoPostProcessingFile

java.lang.String writeBase64IntoPostProcessingFile(java.util.List<java.lang.String> base64FileContent,
                                                   java.lang.String originalFileName,
                                                   double width_mm,
                                                   double height_mm)
                                            throws java.io.IOException

Writes a base64 encoded content into the report as an embedded file.

The file could be embedded in the target output. If the file represents an image, width and height can be specified (0 = unspecified)

Parameters:

stringList - file content

originalFileName - original file name

width_mm - width in mm (0 = unspecified)

height_mm - height in mm (0 = unspecified)

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeDecoratedImage

java.lang.String writeDecoratedImage(java.lang.String fileNameOfImageToDecorate,
                                     double toGray,
                                     java.lang.String fileNameOfDecoratorImage,
                                     double width_mm,
                                     double height_mm)

Writes an image into the report as an embedded file.

The image is created by decorating one image with another. The decorater is placed in the lower right of the image. The resulting image could be embedded in the target output.

Call writeBase64IntoPreProcessingFile(List, String, String), ICustomPropertiesAccess#getFilePropertyAsFileName(String, String) or {@link #writeDecoratedImageAlignedIntoPreProcessingFile(String, double, int, int, String, int, int, int, int)} to get the file names.

Parameters:

fileNameOfImageToDecorate -

toGray - 0 (leave image to decorate as is) .. 1 (gray)

fileNameOfDecoratorImage -

width_mm - width in mm (0 = unspecified)

height_mm - height in mm (0 = unspecified)

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeDecoratedImage

java.lang.String writeDecoratedImage(java.lang.String fileNameOfImageToDecorate,
                                     double toGray,
                                     java.lang.String fileNameOfDecoratorImage)

Writes an image into the report as an embedded file.

The image is created by decorating one image with another. The decorater is placed in the lower right of the image. The resulting image could be embedded in the target output.

Call writeBase64IntoPreProcessingFile(List, String, String), ICustomPropertiesAccess#getFilePropertyAsFileName(String, String) or {@link #writeDecoratedImageAlignedIntoPreProcessingFile(String, double, int, int, String, int, int, int, int)} to get the file names.

Parameters:

fileNameOfImageToDecorate -

toGray - 0 (leave image to decorate as is) .. 1 (gray)

fileNameOfDecoratorImage -

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeDecoratedImageAligned

java.lang.String writeDecoratedImageAligned(java.lang.String fileNameOfImageToDecorate,
                                            double toGray,
                                            int baseAlignX,
                                            int baseAlignY,
                                            java.lang.String fileNameOfDecoratorImage,
                                            int alignX,
                                            int alignY,
                                            int offX,
                                            int offY)

Writes an image into the report as an embedded file.

The image is created by decorating one image with another. The decorater is placed in the lower right of the image. The resulting image could be embedded in the target output.

Call writeBase64IntoPreProcessingFile(List, String, String), ICustomPropertiesAccess#getFilePropertyAsFileName(String, String) or {@link #writeDecoratedImageAlignedIntoPreProcessingFile(String, double, int, int, String, int, int, int, int)} to get the file names.

Parameters:

fileNameOfImageToDecorate -

toGray - 0 (leave image to decorate as is) .. 1 (gray)

baseAlignX - alignment within image to decorate: 0 = left border, 1 = center, 2 = right border

baseAlignX - alignment within image to decorate: 0 = top, 1 = center, 2 = bottom

fileNameOfDecoratorImage -

alignX - alignment of decorator image: 0 = flow to the left, 1 = centered, 2 = flow to the right

alignY - alignment of decorator image: 0 = flow upwards, 1 = centered, 2 = flow downwards

offX - offset X in pixels (positive = move to right)

offY - offset Y in pixels (positive = move downwards)

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeDecoratedImageAligned

java.lang.String writeDecoratedImageAligned(java.lang.String fileNameOfImageToDecorate,
                                            double toGray,
                                            int baseAlignX,
                                            int baseAlignY,
                                            java.lang.String fileNameOfDecoratorImage,
                                            int alignX,
                                            int alignY,
                                            int offX,
                                            int offY,
                                            double width_mm,
                                            double height_mm)

Writes an image into the report as an embedded file.

The image is created by decorating one image with another. The decorater is placed in the lower right of the image. The resulting image could be embedded in the target output.

Call writeBase64IntoPreProcessingFile(List, String, String), ICustomPropertiesAccess#getFilePropertyAsFileName(String, String) or {@link #writeDecoratedImageAlignedIntoPreProcessingFile(String, double, int, int, String, int, int, int, int)} to get the file names.

Parameters:

fileNameOfImageToDecorate -

toGray - 0 (leave image to decorate as is) .. 1 (gray)

baseAlignX - alignment within image to decorate: 0 = left border, 1 = center, 2 = right border

baseAlignX - alignment within image to decorate: 0 = top, 1 = center, 2 = bottom

fileNameOfDecoratorImage -

alignX - alignment of decorator image: 0 = flow to the left, 1 = centered, 2 = flow to the right

alignY - alignment of decorator image: 0 = flow upwards, 1 = centered, 2 = flow downwards

offX - offset X in pixels (positive = move to right)

offY - offset Y in pixels (positive = move downwards)

width_mm - width in mm (0 = unspecified)

height_mm - height in mm (0 = unspecified)

Returns:

a doc book string to embed the created file

Throws:

java.io.IOException

writeDecoratedImageAlignedIntoPreProcessingFile

java.lang.String writeDecoratedImageAlignedIntoPreProcessingFile(java.lang.String fileNameOfImageToDecorate,
                                                                 double toGray,
                                                                 int baseAlignX,
                                                                 int baseAlignY,
                                                                 java.lang.String fileNameOfDecoratorImage,
                                                                 int alignX,
                                                                 int alignY,
                                                                 int offX,
                                                                 int offY)

Writes an image into into a temporary file.

The file is created a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

The image is created by decorating one image with another. The decorater is placed in the lower right of the image.

Call writeBase64IntoPreProcessingFile(List, String, String), ICustomPropertiesAccess#getFilePropertyAsFileName(String, String) or {@link #writeDecoratedImageAlignedIntoPreProcessingFile(String, double, int, int, String, int, int, int, int)} to get the file names.

Parameters:

fileNameOfImageToDecorate -

toGray - 0 (leave image to decorate as is) .. 1 (gray)

baseAlignX - alignment within image to decorate: 0 = left border, 1 = center, 2 = right border

baseAlignX - alignment within image to decorate: 0 = top, 1 = center, 2 = bottom

fileNameOfDecoratorImage -

alignX - alignment of decorator image: 0 = flow to the left, 1 = centered, 2 = flow to the right

alignY - alignment of decorator image: 0 = flow upwards, 1 = centered, 2 = flow downwards

offX - offset X in pixels (positive = move to right)

offY - offset Y in pixels (positive = move downwards)

Returns:

the local file name of the decorated image

Throws:

java.io.IOException

encodeRecordIntoPreprocessingXMLFile

java.lang.String encodeRecordIntoPreprocessingXMLFile(IRecord record,
                                                      java.lang.String rootName,
                                                      java.lang.String namespace,
                                                      java.lang.String encoding,
                                                      boolean formatOutput)
                                               throws com.arcway.lib.codec.xml.EXXMLEncodingFailed

Encodes a record into a temporary XML file.

The file is created a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

record -

rootName - the name for the XML root element (must not be null)

namespace - the namespace (null for none)

encoding - the encoding (e.g. "UTF-8") (must be valid supported and not null)

formatOutput - true if the output should be formatted (with indents and line feeds), false if not

Returns:

the file name of the generated file (never null)

Throws:

com.arcway.lib.codec.xml.EXXMLEncodingFailed - if encoding failed for some reason

encodeRecordIntoXMLString

java.lang.String encodeRecordIntoXMLString(IRecord record,
                                           java.lang.String rootName,
                                           java.lang.String namespace,
                                           java.lang.String encoding,
                                           boolean formatOutput)
                                    throws com.arcway.lib.codec.xml.EXXMLEncodingFailed

Encodes a record into an XML String.

Parameters:

record -

rootName - the name for the XML root element (must not be null)

namespace - the namespace (null for none)

encoding - the encoding (e.g. "UTF-8") (must be valid supported and not null)

formatOutput - true if the output should be formatted (with indents and line feeds), false if not

Returns:

the string (never null)

Throws:

com.arcway.lib.codec.xml.EXXMLEncodingFailed - if encoding failed for some reason

decodeRecordFromXMLFile

IRecord decodeRecordFromXMLFile(java.lang.String fileNameOfFileToBeRead)
                         throws com.arcway.lib.codec.xml.EXXMLDecodingFailed,
                                java.io.IOException

Decodes a record from an XML file.

Parameters:

fileNameOfFileToBeRead - the xml file (must not be null)

Returns:

the decoded record

Throws:

java.io.UnsupportedEncodingException

com.arcway.lib.codec.xml.EXXMLDecodingFailed - if decoding failed for some reason

java.io.FileNotFoundException

java.io.IOException

decodeRecordFromXMLString

IRecord decodeRecordFromXMLString(java.lang.String xmlString,
                                  java.lang.String encoding)
                           throws java.io.UnsupportedEncodingException,
                                  com.arcway.lib.codec.xml.EXXMLDecodingFailed

Decodes a record from an XML String.

Parameters:

xmlString - the xmlString (must not be null)

encoding - the encoding (must be the same that is stated in the XML header!)

Returns:

the decoded record

Throws:

java.io.UnsupportedEncodingException

com.arcway.lib.codec.xml.EXXMLDecodingFailed - if decoding failed for some reason

loadXMLFileIntoRecord

IRecord loadXMLFileIntoRecord(java.lang.String fileNameOfFileToBeRead)
                       throws com.arcway.lib.codec.xml.EXXMLDecodingFailed,
                              java.io.IOException

Loads an XML file into a record. Note: This method can load any XML file into a record. The returned record is a 1:1 conversion of an XML file. The keys within the record are:

• Key "typeID": value is a String containing the xml tag name (mandatory)
• Key "namespace": value is a String containing the xml namespace (optional)
• Keys "attribute." + : only one value per attribute; each value is a String containing the attribute value
• Key "content": values are either Strings containing the content of the XML element, or
• Key "content": values are IRecords containing the child XML elements (syntax is same like for this element), or
• Key "content": values are XMLProcessingInstructions

Parameters:

fileNameOfFileToBeRead - the xml file (must not be null)

Returns:

the decoded record

Throws:

java.io.UnsupportedEncodingException

com.arcway.lib.codec.xml.EXXMLDecodingFailed - if decoding failed for some reason

java.io.FileNotFoundException

java.io.IOException

loadXMLFileIntoRecord

IRecord loadXMLFileIntoRecord(java.lang.String xmlString,
                              java.lang.String encoding)
                       throws java.io.UnsupportedEncodingException,
                              com.arcway.lib.codec.xml.EXXMLDecodingFailed

Loads an XML file (represented as string) into a record. Note: This method can load any XML file into a record. The returned record is a 1:1 conversion of an XML file. The keys within the record are described here: loadXMLFileIntoRecord(String)

Parameters:

fileNameOfFileToBeRead - the xml file (must not be null)

Returns:

the decoded record

Throws:

java.io.UnsupportedEncodingException

com.arcway.lib.codec.xml.EXXMLDecodingFailed - if decoding failed for some reason

java.io.FileNotFoundException

java.io.IOException

saveXMLFileFromRecordIntoPreprocessingXMLFile

java.lang.String saveXMLFileFromRecordIntoPreprocessingXMLFile(IRecord record,
                                                               java.lang.String fileNamePrefix,
                                                               java.lang.String encoding,
                                                               int formatOutput)
                                                        throws com.arcway.lib.codec.xml.EXXMLEncodingFailed

Stores an XML file as contained in a record into a temporary XML file.

The file is created a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output. Note: This method can store any XML file. Therefore the record needs to follow a given syntax as described here: loadXMLFileIntoRecord(String). For creating XML processing instructions, see also: IArrayHelper.createProcessingInstruction(String, String)

Parameters:

record -

fileNamePrefix - a prefix for the filename of the temp file (file extension is ".xml")

encoding - the encoding (e.g. "UTF-8") (must be valid supported and not null)

formatOutput - 0 if the output should not be formatted, -1 or 1 if the output should be formatted (with indents and line feeds), 2 is like 0, but CR, LF and TABs are not escaped

Returns:

the file name of the generated file (never null)

Throws:

com.arcway.lib.codec.xml.EXXMLEncodingFailed - if encoding failed for some reason

saveXMLFileFromRecordIntoXMLString

java.lang.String saveXMLFileFromRecordIntoXMLString(IRecord record,
                                                    java.lang.String encoding,
                                                    int formatOutput)
                                             throws com.arcway.lib.codec.xml.EXXMLEncodingFailed

Stores an XML file as contained in a record into a XML String. Note: This method can store any XML file. Therefore the record needs to follow a given syntax as described here: loadXMLFileIntoRecord(String). For creating XML processing instructions, see also: IArrayHelper.createProcessingInstruction(String, String)

Parameters:

record -

encoding - the encoding (e.g. "UTF-8") (must be valid supported and not null)

formatOutput - 0 if the output should not be formatted, -1 or 1 if the output should be formatted (with indents and line feeds), 2 is like 0, but CR, LF and TABs are not escaped

Returns:

the string (never null)

Throws:

com.arcway.lib.codec.xml.EXXMLEncodingFailed - if encoding failed for some reason

createPostProcessingFile

java.lang.String createPostProcessingFile(java.lang.String fileName)

Creates a file name. The file can be created by the report.

The file could be embedded in the target output.

Parameters:

graphicsAndFilesHelper -

fileName - file name with extension (no path name, special characters should be avoided, length > 32 should be avoided)

Returns:

absolute valid file name (including path names)

addExtensionIfMissing

java.lang.String addExtensionIfMissing(java.lang.String fileName,
                                       java.lang.String extension)

Adds a certain file extension, if none is existing.

Parameters:

fileName - the file or path name

extension - the extension to add (e.g. "png"), without the separator

Returns:

the file with extension

moveFile

boolean moveFile(java.lang.String sourceFileName,
                 java.lang.String destinationFileName)

moves a file from source to destination The destination file is deleted if it already exists.

Parameters:

sourceFileName -

destinationFileName -

Returns:

true in case of success

deleteFileOrDirectory

boolean deleteFileOrDirectory(java.lang.String fileOrDirectoryName)

Deletes
- a File
or
- a Directory and its contents (recursively)
if it exists. Does nothing if it does not exist.

Parameters:

fileOrDirectoryName - (must not be null)

Returns:

true in case of success

deleteExistingFileOrDirectory

boolean deleteExistingFileOrDirectory(java.lang.String fileOrDirectoryName)

Deletes
- a File
or
- a Directory and its contents (recursively)

Parameters:

fileOrDirectoryName - (must not be null)

Returns:

true in case of success

deleteContentOfDirectory

boolean deleteContentOfDirectory(java.lang.String directoryName)

deletes the content of the directory but not the directory itself

Parameters:

directoryName -

Returns:

true in case of success

ensureDirectoryExistance

boolean ensureDirectoryExistance(java.lang.String directoryName)

ensureDirectoryExisitance

Parameters:

directory - (if null, this method does nothing)

Returns:

the directories that were actually created (never null)

copyFile

boolean copyFile(java.lang.String sourceName,
                 java.lang.String destinationName)

copies a file from source to destination

Parameters:

sourceName -

destinationName -

Returns:

true in case of success

copyDirectoryContent

boolean copyDirectoryContent(java.lang.String srcDirectoryName,
                             java.lang.String trgtDirectoryName)

copies a directory's content into another directory

Parameters:

srcDirectoryName -

trgtDirectoryName -

Returns:

true in case of success

getFileExtension

java.lang.String getFileExtension(java.lang.String fileName)

Extracts the file extension from the given file name.

Parameters:

fileName - the fileName

Returns:

the file extension

doesDirectoryContainEssentialFiles

boolean doesDirectoryContainEssentialFiles(java.lang.String directoryName,
                                           boolean ignoreDirectoryEntries,
                                           boolean ignoreAuxiliaryFiles)

Checks if a directory contains relevant files. The call parameters specify if everything that is contained should be deemed relevant or if empty directories and auxiliary files shall be ignored.

Parameters:

directoryName -

ignoreDirectoryEntries - directories are ignored if they itself contain no essential files

ignoreAuxiliaryFiles - ignored files are ".DS_Store", "Thumbs.db and all files starting with "._".

Returns:

true if there are essential files found

convertStringToPortableFileName

java.lang.String convertStringToPortableFileName(java.lang.String string)

Replaces all invalid characters in a file name by underscores

Parameters:

string - the name of the file with or without extension but without any paths

Returns:

!= null

shortenFileName

java.lang.String shortenFileName(java.lang.String fileName,
                                 int maxLength)

Shortens the name to the specidfied maximum length while preserving the file extension. The part of the name in front of the extension will be shortened, so that the specified maximum length is not exceeded.

ATTENTION: If the maximum length is shorter or equal to the length of the extension plus the extension separator, then at least one character of the filename is preserverd. That means that the resulting string always has at least a lenght of lengthOfExtension + 2.

Examples:
VeryLongFileName.png with a specified maximum length of 10 results in VeryLo.png VeryLongFileName.png with a specified maximum length of 3 results in V.png VeryLongFileName with a specified maximum length of 10 results in VeryLongFi VeryLongFileName with a specified maximum length of 3 results in Ver

Parameters:

fileName - the name of the file with or without extension but without any paths

maxLength - the maximum length of the file name (includes extension)

Returns:

!= null

listDirectoryContent

java.util.Collection<java.lang.String> listDirectoryContent(java.lang.String directory)

Returns the names of all files and folders of a certain directory.

Returns:

file names

getFileNameWithoutPath

java.lang.String getFileNameWithoutPath(java.lang.String fileName)

Returns the name of the file or directory denoted by an abstract pathname. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.

Returns:

The name of the file or directory denoted by this abstract pathname, or the empty string if this pathname's name sequence is empty

getParent

java.lang.String getParent(java.lang.String fileName)

Returns the pathname string of the parent, or null if the pathname does not name a parent directory.

The parent of an abstract pathname consists of the pathname's prefix, if any, and each name in the pathname's name sequence except for the last. If the name sequence is empty then the pathname does not name a parent directory.

Returns:

The pathname string of the parent directory named by this abstract pathname, or null if this pathname does not name a parent

getChild

java.lang.String getChild(java.lang.String parentFileName,
                          java.lang.String childName)

Creates a filename from a parent pathname string and a child pathname string.

If parent is null then the resulting pathname is created as if only child is given.

Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If parent is the empty string then the file name is created by resolving the child against a system-dependent default directory. Otherwise the child pathname is resolved against the parent.

Parameters:

parent - The parent pathname string

child - The child pathname string

Throws:

java.lang.NullPointerException - If child is null

isDirectory

boolean isDirectory(java.lang.String fileName)

Tests whether the file denoted by this abstract pathname is a directory.

Returns:

true if and only if the file denoted by this abstract pathname exists and is a directory; false otherwise

isFile

boolean isFile(java.lang.String fileName)

Tests whether the file denoted by this abstract pathname is a normal file. A file is normal if it is not a directory and, in addition, satisfies other system-dependent criteria. Any non-directory file created by a Java application is guaranteed to be a normal file.

Returns:

true if and only if the file denoted by this abstract pathname exists and is a normal file; false otherwise

isHidden

boolean isHidden(java.lang.String fileName)

Tests whether the file named by this abstract pathname is a hidden file. The exact definition of hidden is system-dependent. On UNIX systems, a file is considered to be hidden if its name begins with a period character ('.'). On Microsoft Windows systems, a file is considered to be hidden if it has been marked as such in the filesystem.

Returns:

true if and only if the file denoted by this abstract pathname is hidden according to the conventions of the underlying platform

lastModified

long lastModified(java.lang.String fileName)

Returns the time that the file denoted by this abstract pathname was last modified.

Returns:

A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O error occurs

length

long length(java.lang.String fileName)

Returns the length of the file denoted by this abstract pathname. The return value is unspecified if this pathname denotes a directory.

Returns:

The length, in bytes, of the file denoted by this abstract pathname, or 0L if the file does not exist. Some operating systems may return 0L for pathnames denoting system-dependent entities such as devices or pipes.

setLastModified

boolean setLastModified(java.lang.String fileName,
                        long time)

Sets the last-modified time of the file or directory named by this abstract pathname.

All platforms support file-modification times to the nearest second, but some provide more precision. The argument will be truncated to fit the supported precision. If the operation succeeds and no intervening operations on the file take place, then the next invocation of the lastModified(java.lang.String) method will return the (possibly truncated) time argument that was passed to this method.

Parameters:

time - The new last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)

Returns:

true if and only if the operation succeeded; false otherwise

Throws:

java.lang.IllegalArgumentException - If the argument is negative

setReadOnly

boolean setReadOnly(java.lang.String fileName)

Marks the file or directory named by this abstract pathname so that only read operations are allowed. After invoking this method the file or directory is guaranteed not to change until it is either deleted or marked to allow write access. Whether or not a read-only file or directory may be deleted depends upon the underlying system.

Returns:

true if and only if the operation succeeded; false otherwise