pt.lsts.neptus.util

Class FileUtil

java.lang.Object

pt.lsts.neptus.util.FileUtil

public class FileUtil
extends java.lang.Object

Author:

pdias

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	BOM_UTF16BE Byte order mark for UTF-16 big-endian
static byte[]	BOM_UTF16LE Byte order mark for UTF-16 little-endian
static byte[]	BOM_UTF32BE Byte order mark for UTF-32 big-endian
static byte[]	BOM_UTF32LE Byte order mark for UTF-32 little-endian
static byte[]	BOM_UTF8 Byte order mark for UTF-8
static java.lang.String	FILE_TYPE_CHECKLIST Checklist file extension
static java.lang.String	FILE_TYPE_CONFIG Config file extension (not used often)
static java.lang.String	FILE_TYPE_CONSOLE Console file extension
static java.lang.String	FILE_TYPE_INI INI file extension
static java.lang.String	FILE_TYPE_LSF LSF (LSTS Serialized Format) file extension
static java.lang.String	FILE_TYPE_LSF_COMPRESSED GZipped compressed LSF (LSTS Serialized Format) file extension
static java.lang.String	FILE_TYPE_LSF_COMPRESSED_BZIP2 BZipped2 compressed LSF (LSTS Serialized Format) file extension
static java.lang.String	FILE_TYPE_MAP Map file extension
static java.lang.String	FILE_TYPE_MISSION Mission file extension
static java.lang.String	FILE_TYPE_MISSION_COMPRESSED Compressed mission file extension
static java.lang.String	FILE_TYPE_RMF RMF (REMUS Mission Format) file extension (not used often now)
static java.lang.String	FILE_TYPE_VEHICLE Vehicle file extension
static java.lang.String	FILE_TYPE_WSN WSN (Wireless Sensor Network) file extension (not used often now)
static java.lang.String	FILE_TYPE_XML XML file extension

Method Summary

Modifier and Type	Method and Description
static void	appendToFile(java.io.File destination, java.io.File fileToBeAppended) This will append one file to the destination.
static void	appendToFile(java.io.File destination, java.io.InputStream source) This will appends the source to the destination file and close it.
static boolean	appendToFile(java.lang.String fileName, java.lang.String dataToSave)
static boolean	appendToFile(java.lang.String fileName, java.lang.String dataToSave, java.lang.String encoding)
static boolean	backupFile(java.lang.String source) This will create a copy of the given file with the bak extension appended into the name.
static java.lang.String	checkFileForExtensions(java.io.File file, java.lang.String... extensions) See checkFileForExtensions(String, String...).
static java.lang.String	checkFileForExtensions(java.lang.String filePath, java.lang.String... extensions) Checks a file name for matching a file extension (case insensitive).
static void	concatFiles(java.io.File destination, java.io.File fileToBeAppended) This concatenates two files.
static boolean	copyFile(java.lang.String source, java.lang.String dest) This will copy the file to some other.
static boolean	copyFileAndBackup(java.lang.String source, java.lang.String out) This will copy the file to some other and also creates a copy of the given file with the bak extension appended into the name.
static boolean	copyFileToDir(java.lang.String source, java.lang.String destDir) This will copy a file to a given folder.
static void	deltree(java.lang.String dir) Deletes the directory and its content.
static java.lang.String	getAsCompactFormatedXMLString(org.dom4j.Document doc) This removes all extra spaces and new lines from the XML and return it.
static java.lang.String	getAsCompactFormatedXMLString(org.dom4j.Document doc, boolean omitDeclaration) This removes all extra spaces and new lines from the XML and return it.
static java.lang.String	getAsCompactFormatedXMLString(java.lang.String xml) This removes all extra spaces and new lines from the XML and return it.
static java.lang.String	getAsCompactFormatedXMLString(java.lang.String xml, boolean omitDeclaration) This removes all extra spaces and new lines from the XML and return it.
static java.lang.String	getAsPrettyPrintFormatedXMLString(org.dom4j.Document doc) This will get a flat or partial formated XML string as a formated XML string.
static java.lang.String	getAsPrettyPrintFormatedXMLString(org.dom4j.Document doc, boolean omitDeclaration) This will get a flat or partial formated XML string as a formated XML string.
static java.lang.String	getAsPrettyPrintFormatedXMLString(java.lang.String xml) This will get a flat or partial formated XML string as a formated XML string.
static java.lang.String	getAsPrettyPrintFormatedXMLString(java.lang.String xml, boolean omitDeclaration) This will get a flat or partial formated XML string as a formated XML string.
static byte[]	getFileAsByteArray(java.lang.String url) Return the file as an byte array.
static java.lang.String	getFileAsString(java.io.File fx) See getFileAsString(String)
static java.lang.String	getFileAsString(java.lang.String url) Returns the content of the file as a UTF-8 (or in the encoding of the file if found, findOutFileEncoding(byte[])) encoded string.
static java.lang.String	getFileExtension(java.io.File fx) Returns the file extension string.
static java.lang.String	getFileExtension(java.lang.String path) Returns the file extension string.
static java.lang.String	getFileNameWithoutExtension(java.io.File fx) Return the file name without extension.
static java.lang.String	getFileNameWithoutExtension(java.lang.String path) Return the file name without extension.
static java.io.File[]	getFilesFromDisk(java.io.File folderToLoad, java.lang.String searchPattern) Get the list of sorted files in folder or null if parent folder doesn't exist or pattern is not valid.
static java.io.File[]	getFoldersFromDisk(java.io.File folderToLoad, java.lang.String searchPattern) Get the list of sorted folders in folder or null if parent folder doesn't exist or pattern is not valid.
static java.lang.String	getPackageAsPath(java.lang.Class<?> clazz) Return the Class package as a path.
static java.lang.String	getPackageAsPath(java.lang.Object obj) Return the Object package as a path.
static java.lang.String	getResourceAsFile(java.lang.String name) Return a resource path as a path.
static java.lang.String	getResourceAsFileKeepName(java.lang.String name) Return a resource path as a path.
static java.io.InputStream	getResourceAsStream(java.lang.String name) Return a resource path as a input stream.
static boolean	loadLibraryFromResource(java.lang.String libResourcePath) Loads a library from resource using System load.
static void	main(java.lang.String[] args)
static java.net.URL	pathToURL(java.lang.String path) This will transform a path into a URL.
static java.lang.String	relativizeFilePath(java.lang.String parentPath, java.lang.String filePath) This will try to relativize the file path in relation to the other.
static java.lang.String	relativizeFilePathAsURI(java.lang.String parentPath, java.lang.String filePath) This will try to relativize the file path in relation to the other as an URI.
static java.lang.String	replaceFileExtension(java.io.File fx, java.lang.String newExtension) Return the file name string with the extension replaced.
static java.lang.String	replaceFileExtension(java.lang.String path, java.lang.String newExtension) Return the file name string with the extension replaced.
static boolean	saveToFile(java.lang.String fileName, java.lang.String dataToSave)
static boolean	saveToFile(java.lang.String fileName, java.lang.String dataToSave, java.lang.String encoding)
static boolean	saveToFile(java.lang.String fileName, java.lang.String dataToSave, java.lang.String encoding, boolean append) This will save the string (dataToSave) to the file with the encoding and appends or overwrite.

Methods inherited from class java.lang.Object

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

Field Detail

BOM_UTF8

public static final byte[] BOM_UTF8

Byte order mark for UTF-8

BOM_UTF16LE

public static final byte[] BOM_UTF16LE

Byte order mark for UTF-16 little-endian

BOM_UTF16BE

public static final byte[] BOM_UTF16BE

Byte order mark for UTF-16 big-endian

BOM_UTF32LE

public static final byte[] BOM_UTF32LE

Byte order mark for UTF-32 little-endian

BOM_UTF32BE

public static final byte[] BOM_UTF32BE

Byte order mark for UTF-32 big-endian

FILE_TYPE_MISSION

public static final java.lang.String FILE_TYPE_MISSION

Mission file extension

See Also:

Constant Field Values

FILE_TYPE_MISSION_COMPRESSED

public static final java.lang.String FILE_TYPE_MISSION_COMPRESSED

Compressed mission file extension

See Also:

Constant Field Values

FILE_TYPE_MAP

public static final java.lang.String FILE_TYPE_MAP

Map file extension

See Also:

Constant Field Values

FILE_TYPE_CONSOLE

public static final java.lang.String FILE_TYPE_CONSOLE

Console file extension

See Also:

Constant Field Values

FILE_TYPE_CONFIG

public static final java.lang.String FILE_TYPE_CONFIG

Config file extension (not used often)

See Also:

Constant Field Values

FILE_TYPE_VEHICLE

public static final java.lang.String FILE_TYPE_VEHICLE

Vehicle file extension

See Also:

Constant Field Values

FILE_TYPE_CHECKLIST

public static final java.lang.String FILE_TYPE_CHECKLIST

Checklist file extension

See Also:

Constant Field Values

FILE_TYPE_WSN

public static final java.lang.String FILE_TYPE_WSN

WSN (Wireless Sensor Network) file extension (not used often now)

See Also:

Constant Field Values

FILE_TYPE_INI

public static final java.lang.String FILE_TYPE_INI

INI file extension

See Also:

Constant Field Values

FILE_TYPE_RMF

public static final java.lang.String FILE_TYPE_RMF

RMF (REMUS Mission Format) file extension (not used often now)

See Also:

Constant Field Values

FILE_TYPE_XML

public static final java.lang.String FILE_TYPE_XML

XML file extension

See Also:

Constant Field Values

FILE_TYPE_LSF

public static final java.lang.String FILE_TYPE_LSF

LSF (LSTS Serialized Format) file extension

See Also:

Constant Field Values

FILE_TYPE_LSF_COMPRESSED

public static final java.lang.String FILE_TYPE_LSF_COMPRESSED

GZipped compressed LSF (LSTS Serialized Format) file extension

See Also:

Constant Field Values

FILE_TYPE_LSF_COMPRESSED_BZIP2

public static final java.lang.String FILE_TYPE_LSF_COMPRESSED_BZIP2

BZipped2 compressed LSF (LSTS Serialized Format) file extension

See Also:

Constant Field Values

Method Detail

getFileExtension

public static java.lang.String getFileExtension(java.io.File fx)

Returns the file extension string.

Parameters:

fx -

Returns:

getFileExtension

public static java.lang.String getFileExtension(java.lang.String path)

Returns the file extension string.

Parameters:

path -

Returns:

getFileNameWithoutExtension

public static java.lang.String getFileNameWithoutExtension(java.io.File fx)

Return the file name without extension.

Parameters:

fx -

Returns:

getFileNameWithoutExtension

public static java.lang.String getFileNameWithoutExtension(java.lang.String path)

Return the file name without extension.

Parameters:

path -

Returns:

replaceFileExtension

public static java.lang.String replaceFileExtension(java.io.File fx,
                                                    java.lang.String newExtension)

Return the file name string with the extension replaced.

Parameters:

fx -

newExtension -

Returns:

replaceFileExtension

public static java.lang.String replaceFileExtension(java.lang.String path,
                                                    java.lang.String newExtension)

Return the file name string with the extension replaced.

Parameters:

path -

newExtension -

Returns:

checkFileForExtensions

public static java.lang.String checkFileForExtensions(java.io.File file,
                                                      java.lang.String... extensions)

See checkFileForExtensions(String, String...).

Parameters:

file -

extensions -

Returns:

checkFileForExtensions

public static java.lang.String checkFileForExtensions(java.lang.String filePath,
                                                      java.lang.String... extensions)

Checks a file name for matching a file extension (case insensitive).

Parameters:

filePath -

extensions -

Returns:

The extension that matched or null if not.

getFileAsString

public static java.lang.String getFileAsString(java.io.File fx)

See getFileAsString(String)

Parameters:

fx -

Returns:

getFileAsString

public static java.lang.String getFileAsString(java.lang.String url)

Returns the content of the file as a UTF-8 (or in the encoding of the file if found, findOutFileEncoding(byte[])) encoded string.

Parameters:

url - The URL or relative file path.

Returns:

getFilesFromDisk

public static java.io.File[] getFilesFromDisk(java.io.File folderToLoad,
                                              java.lang.String searchPattern)

Get the list of sorted files in folder or null if parent folder doesn't exist or pattern is not valid.

Parameters:

folderToLoad -

searchPattern - null for all

Returns:

getFoldersFromDisk

public static java.io.File[] getFoldersFromDisk(java.io.File folderToLoad,
                                                java.lang.String searchPattern)

Get the list of sorted folders in folder or null if parent folder doesn't exist or pattern is not valid.

Parameters:

folderToLoad -

searchPattern - null for all

Returns:

getFileAsByteArray

public static byte[] getFileAsByteArray(java.lang.String url)

Return the file as an byte array.

Parameters:

url - The URL or file path for the file

Returns:

getAsPrettyPrintFormatedXMLString

public static java.lang.String getAsPrettyPrintFormatedXMLString(java.lang.String xml)

This will get a flat or partial formated XML string as a formated XML string. (With XML declaration, getAsPrettyPrintFormatedXMLString(String, boolean) )

Parameters:

xml -

Returns:

getAsPrettyPrintFormatedXMLString

public static java.lang.String getAsPrettyPrintFormatedXMLString(java.lang.String xml,
                                                                 boolean omitDeclaration)

This will get a flat or partial formated XML string as a formated XML string.

Parameters:

xml -

omitDeclaration - If the declaration of the XML file is to be included or omitted.

Returns:

getAsCompactFormatedXMLString

public static java.lang.String getAsCompactFormatedXMLString(java.lang.String xml)

This removes all extra spaces and new lines from the XML and return it. (With XML declaration, getAsCompactFormatedXMLString(String, boolean) )

Parameters:

xml -

Returns:

getAsCompactFormatedXMLString

public static java.lang.String getAsCompactFormatedXMLString(java.lang.String xml,
                                                             boolean omitDeclaration)

This removes all extra spaces and new lines from the XML and return it.

Parameters:

xml -

omitDeclaration - If the declaration of the XML file is to be included or omitted.

Returns:

getAsPrettyPrintFormatedXMLString

public static java.lang.String getAsPrettyPrintFormatedXMLString(org.dom4j.Document doc)

This will get a flat or partial formated XML string as a formated XML string. (With XML declaration, getAsPrettyPrintFormatedXMLString(Document, boolean) )

Parameters:

doc -

Returns:

getAsPrettyPrintFormatedXMLString

public static java.lang.String getAsPrettyPrintFormatedXMLString(org.dom4j.Document doc,
                                                                 boolean omitDeclaration)

This will get a flat or partial formated XML string as a formated XML string.

Parameters:

doc -

omitDeclaration - If the declaration of the XML file is to be included or omitted.

Returns:

getAsCompactFormatedXMLString

public static java.lang.String getAsCompactFormatedXMLString(org.dom4j.Document doc)

This removes all extra spaces and new lines from the XML and return it. (With XML declaration, getAsCompactFormatedXMLString(String, boolean) )

Parameters:

doc -

Returns:

getAsCompactFormatedXMLString

public static java.lang.String getAsCompactFormatedXMLString(org.dom4j.Document doc,
                                                             boolean omitDeclaration)

This removes all extra spaces and new lines from the XML and return it.

Parameters:

doc -

omitDeclaration - If the declaration of the XML file is to be included or omitted.

Returns:

appendToFile

public static void appendToFile(java.io.File destination,
                                java.io.InputStream source)
                         throws java.lang.Exception

This will appends the source to the destination file and close it.

Parameters:

destination -

source -

Throws:

java.lang.Exception

concatFiles

public static void concatFiles(java.io.File destination,
                               java.io.File fileToBeAppended)
                        throws java.lang.Exception

This concatenates two files.

Parameters:

destination -

fileToBeAppended -

Throws:

java.lang.Exception

appendToFile

public static void appendToFile(java.io.File destination,
                                java.io.File fileToBeAppended)
                         throws java.lang.Exception

This will append one file to the destination.

Parameters:

destination -

fileToBeAppended -

Throws:

java.lang.Exception

appendToFile

public static boolean appendToFile(java.lang.String fileName,
                                   java.lang.String dataToSave,
                                   java.lang.String encoding)

Parameters:

fileName -

dataToSave -

encoding -

Returns:

See Also:

saveToFile(String, String, String, boolean)

appendToFile

public static boolean appendToFile(java.lang.String fileName,
                                   java.lang.String dataToSave)

Parameters:

fileName -

dataToSave -

Returns:

See Also:

saveToFile(String, String, String, boolean)

saveToFile

public static boolean saveToFile(java.lang.String fileName,
                                 java.lang.String dataToSave,
                                 java.lang.String encoding)

Parameters:

fileName -

dataToSave -

encoding -

Returns:

See Also:

saveToFile(String, String, String, boolean)

saveToFile

public static boolean saveToFile(java.lang.String fileName,
                                 java.lang.String dataToSave)

Parameters:

fileName -

dataToSave -

Returns:

See Also:

saveToFile(String, String, String, boolean)

saveToFile

public static boolean saveToFile(java.lang.String fileName,
                                 java.lang.String dataToSave,
                                 java.lang.String encoding,
                                 boolean append)

This will save the string (dataToSave) to the file with the encoding and appends or overwrite.

Parameters:

fileName - File path to save to.

dataToSave - String with the data.

encoding - The encoding of the output file.

append - Indicates if the data is to be appended to the file.

Returns:

true if succeeds

backupFile

public static boolean backupFile(java.lang.String source)

This will create a copy of the given file with the bak extension appended into the name.

Parameters:

source -

Returns:

copyFileAndBackup

public static boolean copyFileAndBackup(java.lang.String source,
                                        java.lang.String out)

This will copy the file to some other and also creates a copy of the given file with the bak extension appended into the name.

Parameters:

source -

out -

Returns:

copyFile

public static boolean copyFile(java.lang.String source,
                               java.lang.String dest)

This will copy the file to some other.

Parameters:

source -

out -

Returns:

copyFileToDir

public static boolean copyFileToDir(java.lang.String source,
                                    java.lang.String destDir)

This will copy a file to a given folder.

Parameters:

source -

destDir -

Returns:

relativizeFilePathAsURI

public static java.lang.String relativizeFilePathAsURI(java.lang.String parentPath,
                                                       java.lang.String filePath)

This will try to relativize the file path in relation to the other as an URI.

Parameters:

parentPath - The path to relativize to

filePath - The path to be relativized

Returns:

relativizeFilePath

public static java.lang.String relativizeFilePath(java.lang.String parentPath,
                                                  java.lang.String filePath)

This will try to relativize the file path in relation to the other.

Parameters:

parentPath - The path to relativize to

filePath - The path to be relativized

Returns:

deltree

public static void deltree(java.lang.String dir)

Deletes the directory and its content. If dir is a file only deletes the file. If the directory does not exist, nothing will be done.

Parameters:

dir -

pathToURL

public static java.net.URL pathToURL(java.lang.String path)
                              throws java.net.MalformedURLException

This will transform a path into a URL.

Parameters:

path -

Returns:

Throws:

java.net.MalformedURLException

getResourceAsFile

public static java.lang.String getResourceAsFile(java.lang.String name)

Return a resource path as a path. It can be a absolute path of a relative path to the caller. The resource is extracted as a temporary file.

Parameters:

name -

Returns:

getResourceAsStream

public static java.io.InputStream getResourceAsStream(java.lang.String name)

Return a resource path as a input stream. It can be a absolute path of a relative path to the caller.

Parameters:

name -

Returns:

getResourceAsFileKeepName

public static java.lang.String getResourceAsFileKeepName(java.lang.String name)

Return a resource path as a path. The name of the file match the resource name. The resource is extracted as a temporary file.

Parameters:

name -

Returns:

loadLibraryFromResource

public static boolean loadLibraryFromResource(java.lang.String libResourcePath)

Loads a library from resource using System load.

Parameters:

libResourcePath -

Returns:

getPackageAsPath

public static java.lang.String getPackageAsPath(java.lang.Object obj)

Return the Object package as a path.

Parameters:

obj -

Returns:

getPackageAsPath

public static java.lang.String getPackageAsPath(java.lang.Class<?> clazz)

Return the Class package as a path.

Parameters:

clazz -

Returns:

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException