de.ipcon.tools

Class FileTools

java.lang.Object

de.ipcon.tools.FileTools

public final class FileTools
extends java.lang.Object

Utility class for file operations, I/O streaming, filesystem probes, and checksum calculation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileTools.FileContentWriter Strategy interface for writing content to an open, managed OutputStream.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.file.CopyOption[]	EMPTY_COPY_OPTION_ARRAY
static java.nio.file.LinkOption[]	EMPTY_LINK_OPTION_ARRAY
static java.nio.file.StandardOpenOption[]	EMPTY_STANDARD_OPEN_OPTION_ARRAY
static java.lang.String	SLASH

Method Summary

Modifier and Type	Method and Description
static java.io.File	atomicMove(java.io.File src, java.io.File dst) Moves a file atomically within the same filesystem.
static java.lang.String	combineRelativePathsAsNeeded(java.lang.String outerPath, java.lang.String innerPath) Combines and normalizes two relative path segments.
static boolean	containsInvalidFilenameChars(java.lang.String filename) Returns true if the filename contains characters outside [a-zA-Z0-9_\-].
static long	copy(java.io.InputStream is, java.io.DataOutput os, long maxlen)
static long	copy(java.io.InputStream is, java.io.OutputStream os)
static long	copy(java.io.InputStream is, java.io.OutputStream os, boolean forceFSSync)
static long	copy(java.io.InputStream is, java.io.OutputStream os, boolean forceFSSync, boolean closeOutputStream)
static long	copy(java.io.InputStream is, java.io.OutputStream os, boolean forceFSSync, boolean closeOutputStream, long maxlen) Copies data from an InputStream to an OutputStream.
static long	copy(java.io.InputStream is, java.io.OutputStream os, long maxlen)
static java.lang.String	copyAndDigest(java.io.InputStream is, java.io.File f, java.lang.String algorithm)
static java.lang.String	copyAndDigest(java.io.InputStream is, java.io.File f, java.lang.String algorithm, boolean forceFSSync) Copies an InputStream to a file while computing its cryptographic hash.
static void	copyFile(java.io.File src, java.io.File dst)
static void	copyFile(java.io.File src, java.io.File dst, boolean forceFSSync) Copies a source file to a destination file.
static java.io.BufferedReader	getBufferedReader(java.io.File f)
static java.io.BufferedReader	getBufferedReader(java.io.File f, java.lang.String charsetName)
static java.io.BufferedReader	getBufferedReader(java.io.InputStream is)
static java.io.BufferedReader	getBufferedReader(java.io.InputStream is, java.lang.String charsetName)
static java.io.BufferedReader	getBufferedReader(java.nio.file.Path path)
static java.io.BufferedReader	getBufferedReader(java.nio.file.Path path, java.lang.String charsetName)
static java.io.BufferedReader	getBufferedReader(java.nio.channels.ReadableByteChannel channel)
static java.io.BufferedReader	getBufferedReader(java.nio.channels.ReadableByteChannel channel, java.lang.String charsetName)
static java.io.BufferedReader	getBufferedReader(java.lang.String content)
static java.io.BufferedReader	getBufferedReader(java.lang.String content, java.lang.String charsetName)
static java.lang.String	getErrortextIfContainsInvalidFilenameChars(java.lang.String filename, java.lang.String attributeName, java.lang.String boDescription) Formats a localized error message if the filename contains invalid characters.
static java.lang.String	getFilenameExtension(java.lang.String filename)
static java.lang.String	getFilenameFromPath(java.lang.String path) Extracts the terminal file name component from a path string.
static java.lang.String	getFilenameNamePart(java.lang.String filename)
static java.lang.String	getHashForBytes(java.lang.String algorithm, byte[] bytes) Computes the cryptographic checksum of a raw byte array.
static java.lang.String	getHashForFile(java.lang.String algorithm, java.io.File f) Computes the cryptographic checksum of a file.
static long	getLinesCount(java.io.File f) Calculates the number of lines in a text file.
static long	getLinesCount(java.lang.String filename)
static java.io.File	getTempDir() Returns the system default temporary directory (java.io.tmpdir) as a File.
static java.nio.file.Path	getTempDirPath() Returns the system default temporary directory (java.io.tmpdir) as a Path.
static java.lang.String	inputStreamToString(java.io.InputStream is)
static java.lang.String	inputStreamToString(java.io.InputStream is, java.lang.String charsetName) Drains an InputStream into a String using the specified charset.
static boolean	isAtomicMoveSupported(java.io.File src, java.io.File dst) Probes whether an atomic move can be performed between the locations of src and dst.
static boolean	isDirectory(java.io.File dir) Verifies that the specified file exists and is a directory.
static boolean	isEmptyDir(java.io.File dir) Checks if an existing directory contains no files or subdirectories.
static boolean	isNonIgnoredFilenameWithOneOfSuffixes(java.io.File f, java.util.Collection<java.lang.String> suffixes) Checks if the file is not ignored and matches one of the accepted extensions.
static boolean	isStandardIgnoreFilename(java.lang.String filename) Checks if a filename matches default VCS and temporary backup patterns (e.g.
static java.lang.String	loadFile(java.io.File f)
static java.lang.String	loadFile(java.io.File f, java.lang.String charsetName) Reads an entire file into a string using the specified encoding.
static java.lang.String	loadFile(java.nio.file.Path p)
static java.lang.String	loadFile(java.nio.file.Path p, java.lang.String charsetName) Reads an entire file path into a string using the specified encoding.
static java.lang.String	loadFile(java.lang.String filename)
static java.lang.String	loadFile(java.lang.String filename, java.lang.String charsetName)
static java.nio.channels.ReadableByteChannel	newChannel(java.lang.String content)
static java.nio.channels.ReadableByteChannel	newChannel(java.lang.String content, int bufferSize)
static java.nio.channels.ReadableByteChannel	newChannel(java.lang.String content, int bufferSize, java.lang.String charsetName)
static java.nio.channels.ReadableByteChannel	newChannel(java.lang.String content, java.lang.String charsetName)
static java.io.InputStream	newInputStream(java.io.File f)
static java.io.InputStream	newInputStream(java.nio.file.Path path)
static java.io.InputStream	newInputStream(java.lang.String content)
static java.io.InputStream	newInputStream(java.lang.String content, java.nio.charset.Charset charset)
static java.io.InputStream	newInputStream(java.lang.String content, int bufferSize)
static java.io.InputStream	newInputStream(java.lang.String content, int bufferSize, java.nio.charset.Charset charset) Creates a buffered or unbuffered InputStream wrapping the provided string bytes.
static java.io.InputStream	newInputStream(java.lang.String content, int bufferSize, java.lang.String charsetName)
static java.io.InputStream	newInputStream(java.lang.String content, java.lang.String charsetName)
static java.nio.channels.FileChannel	newReadingFileChannel(java.io.File f)
static java.nio.channels.FileChannel	newReadingFileChannel(java.nio.file.Path path)
static boolean	open(java.io.File f) Opens the specified file with the desktop default application.
static java.lang.String	packageToFilePath(java.lang.String packageName) Translates a Java package identifier into a filesystem path (replaces dots with separators).
static byte[]	read(java.io.File f) Reads all bytes from a file.
static byte[]	read(java.io.InputStream is) Fully drains an InputStream into a byte array.
static java.lang.String	readIntoString(java.io.BufferedReader br) Reads full content from a BufferedReader and closes it upon completion.
static java.lang.String	readIntoString(java.io.InputStream is)
static java.lang.String	readIntoString(java.io.InputStream is, java.lang.String charsetName) Drains an InputStream into a String using the given charset.
static java.util.List<java.lang.String>	readLines(java.io.File f)
static java.util.List<java.lang.String>	readLines(java.io.File f, long linesToRead)
static java.util.List<java.lang.String>	readLines(java.io.File f, long linesToRead, java.lang.String charsetName)
static java.util.List<java.lang.String>	readLines(java.io.File f, java.lang.String charsetName)
static java.util.List<java.lang.String>	readLines(java.io.File f, java.lang.String charsetName, long linesToRead) Reads up to linesToRead lines from a file.
static java.lang.String	replaceInvalidFilenameChars(java.lang.String filename) Replaces any character not matching [a-zA-Z0-9_\-] with an underscore.
static void	saveFile(byte[] bytes, java.io.File f)
static void	saveFile(byte[] bytes, java.io.File f, boolean forceFSSync)
static void	saveFile(byte[] bytes, java.io.File f, boolean forceFSSync, boolean append)
static void	saveFile(byte[] bytes, java.io.OutputStream fos) Writes raw bytes to an OutputStream and closes it.
static void	saveFile(java.io.InputStream is, java.io.File target)
static void	saveFile(java.io.InputStream is, java.io.File target, boolean forceFSSync)
static void	saveFile(java.io.InputStream is, java.io.File target, boolean forceFSSync, boolean append) Copies an InputStream to a target file.
static void	saveFile(java.lang.String content, java.io.File f)
static void	saveFile(java.lang.String content, java.io.File f, java.lang.String charsetName)
static void	saveFile(java.lang.String content, java.io.File f, java.lang.String charsetName, boolean forceFSSync)
static void	saveFile(java.lang.String content, java.io.File f, java.lang.String charsetName, boolean forceFSSync, boolean append) Saves string content to a file with optional hardware sync and append modes.
static java.lang.String[]	splitFilenameAndExtension(java.lang.String filename) Splits a filename into base name and lowercase extension.
static void	testDir(java.io.File dir) Deprecated. Use isDirectory(File) instead.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LINK_OPTION_ARRAY

public static final java.nio.file.LinkOption[] EMPTY_LINK_OPTION_ARRAY

EMPTY_COPY_OPTION_ARRAY

public static final java.nio.file.CopyOption[] EMPTY_COPY_OPTION_ARRAY

EMPTY_STANDARD_OPEN_OPTION_ARRAY

public static final java.nio.file.StandardOpenOption[] EMPTY_STANDARD_OPEN_OPTION_ARRAY

SLASH

public static final java.lang.String SLASH

Method Detail

getTempDir

public static java.io.File getTempDir()

Returns the system default temporary directory (java.io.tmpdir) as a File.

getTempDirPath

public static java.nio.file.Path getTempDirPath()

Returns the system default temporary directory (java.io.tmpdir) as a Path.

testDir

@Deprecated
public static void testDir(java.io.File dir)

Deprecated. Use isDirectory(File) instead.

isDirectory

public static boolean isDirectory(java.io.File dir)

Verifies that the specified file exists and is a directory.

Parameters:

dir - the directory to check

Returns:

true if the file exists and is a directory

Throws:

MissingArgumentException - if dir is null

java.lang.IllegalArgumentException - if dir does not exist or is not a directory

isEmptyDir

public static boolean isEmptyDir(java.io.File dir)

Checks if an existing directory contains no files or subdirectories.

Parameters:

dir - the directory to check

Returns:

true if the directory is empty

Throws:

MissingArgumentException - if dir is null

java.lang.IllegalArgumentException - if dir does not exist or is not a directory

loadFile

public static java.lang.String loadFile(java.lang.String filename)

loadFile

public static java.lang.String loadFile(java.lang.String filename,
                                        java.lang.String charsetName)

loadFile

public static java.lang.String loadFile(java.io.File f)

loadFile

public static java.lang.String loadFile(java.io.File f,
                                        java.lang.String charsetName)

Reads an entire file into a string using the specified encoding.

Parameters:

f - the file to read

charsetName - character encoding name

Returns:

content as String

Throws:

MissingArgumentException - if f or charsetName is null

IRuntimeException - wrapping IOException or UnsupportedEncodingException

loadFile

public static java.lang.String loadFile(java.nio.file.Path p)

loadFile

public static java.lang.String loadFile(java.nio.file.Path p,
                                        java.lang.String charsetName)

Reads an entire file path into a string using the specified encoding.

Parameters:

p - the path to read

charsetName - character encoding name

Returns:

content as String

Throws:

MissingArgumentException - if p or charsetName is null

IRuntimeException - wrapping IOException or UnsupportedEncodingException

inputStreamToString

public static java.lang.String inputStreamToString(java.io.InputStream is)
                                            throws java.io.IOException

Throws:

java.io.IOException

inputStreamToString

public static java.lang.String inputStreamToString(java.io.InputStream is,
                                                   java.lang.String charsetName)
                                            throws java.io.IOException

Drains an InputStream into a String using the specified charset.

Note: Does not close the provided is.

Parameters:

is - source stream to read

charsetName - character encoding name

Returns:

content as String

Throws:

MissingArgumentException - if is or charsetName is null

java.io.IOException - if an I/O error occurs

readIntoString

public static java.lang.String readIntoString(java.io.InputStream is)
                                       throws java.io.IOException

Throws:

java.io.IOException

readIntoString

public static java.lang.String readIntoString(java.io.InputStream is,
                                              java.lang.String charsetName)
                                       throws java.io.IOException

Drains an InputStream into a String using the given charset.

Throws:

java.io.IOException

readIntoString

public static java.lang.String readIntoString(java.io.BufferedReader br)
                                       throws java.io.IOException

Reads full content from a BufferedReader and closes it upon completion.

Parameters:

br - reader to drain and close

Returns:

content as String with preserved newlines

Throws:

MissingArgumentException - if br is null

java.io.IOException - if reading fails

newReadingFileChannel

public static java.nio.channels.FileChannel newReadingFileChannel(java.io.File f)
                                                           throws java.io.IOException

Throws:

java.io.IOException

newReadingFileChannel

public static java.nio.channels.FileChannel newReadingFileChannel(java.nio.file.Path path)
                                                           throws java.io.IOException

Throws:

java.io.IOException

newInputStream

public static java.io.InputStream newInputStream(java.io.File f)
                                          throws java.io.IOException

Throws:

java.io.IOException

newInputStream

public static java.io.InputStream newInputStream(java.nio.file.Path path)
                                          throws java.io.IOException

Throws:

java.io.IOException

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content,
                                                 java.lang.String charsetName)

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content,
                                                 int bufferSize,
                                                 java.lang.String charsetName)

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content)

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content,
                                                 java.nio.charset.Charset charset)

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content,
                                                 int bufferSize)

newInputStream

public static java.io.InputStream newInputStream(java.lang.String content,
                                                 int bufferSize,
                                                 java.nio.charset.Charset charset)

Creates a buffered or unbuffered InputStream wrapping the provided string bytes.

newChannel

public static java.nio.channels.ReadableByteChannel newChannel(java.lang.String content)

newChannel

public static java.nio.channels.ReadableByteChannel newChannel(java.lang.String content,
                                                               java.lang.String charsetName)

newChannel

public static java.nio.channels.ReadableByteChannel newChannel(java.lang.String content,
                                                               int bufferSize)

newChannel

public static java.nio.channels.ReadableByteChannel newChannel(java.lang.String content,
                                                               int bufferSize,
                                                               java.lang.String charsetName)

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.io.File f)
                                                throws java.io.IOException

Throws:

java.io.IOException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.io.File f,
                                                       java.lang.String charsetName)
                                                throws java.io.IOException

Throws:

java.io.IOException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.nio.file.Path path)
                                                throws java.io.IOException

Throws:

java.io.IOException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.nio.file.Path path,
                                                       java.lang.String charsetName)
                                                throws java.io.IOException

Throws:

java.io.IOException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.nio.channels.ReadableByteChannel channel)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.nio.channels.ReadableByteChannel channel,
                                                       java.lang.String charsetName)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.lang.String content)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.lang.String content,
                                                       java.lang.String charsetName)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.io.InputStream is)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getBufferedReader

public static java.io.BufferedReader getBufferedReader(java.io.InputStream is,
                                                       java.lang.String charsetName)
                                                throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

readLines

public static java.util.List<java.lang.String> readLines(java.io.File f,
                                                         long linesToRead)

readLines

public static java.util.List<java.lang.String> readLines(java.io.File f,
                                                         long linesToRead,
                                                         java.lang.String charsetName)

readLines

public static java.util.List<java.lang.String> readLines(java.io.File f)

readLines

public static java.util.List<java.lang.String> readLines(java.io.File f,
                                                         java.lang.String charsetName)

readLines

public static java.util.List<java.lang.String> readLines(java.io.File f,
                                                         java.lang.String charsetName,
                                                         long linesToRead)

Reads up to linesToRead lines from a file.

Parameters:

f - the file to read

charsetName - character encoding

linesToRead - maximum lines to read, or -1 for all lines

Returns:

list of lines without line terminators

Throws:

MissingArgumentException - if f or charsetName is null

IRuntimeException - wrapping IOException on failure

read

public static byte[] read(java.io.File f)
                   throws java.io.IOException

Reads all bytes from a file. Returns null if f is null.

Throws:

java.io.IOException

read

public static byte[] read(java.io.InputStream is)
                   throws java.io.IOException

Fully drains an InputStream into a byte array. Returns null if is is null.

Throws:

java.io.IOException

getLinesCount

public static long getLinesCount(java.lang.String filename)
                          throws java.io.IOException

Throws:

java.io.IOException

getLinesCount

public static long getLinesCount(java.io.File f)
                          throws java.io.IOException

Calculates the number of lines in a text file.

Empty files return 0. A trailing newline is counted as an additional line.

Parameters:

f - file to count

Returns:

total line count

Throws:

MissingArgumentException - if f is null

java.io.IOException - if reading fails

copyAndDigest

public static java.lang.String copyAndDigest(java.io.InputStream is,
                                             java.io.File f,
                                             java.lang.String algorithm)
                                      throws java.io.IOException,
                                             java.security.NoSuchAlgorithmException

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

copyAndDigest

public static java.lang.String copyAndDigest(java.io.InputStream is,
                                             java.io.File f,
                                             java.lang.String algorithm,
                                             boolean forceFSSync)
                                      throws java.io.IOException,
                                             java.security.NoSuchAlgorithmException

Copies an InputStream to a file while computing its cryptographic hash.

Parameters:

is - source stream

f - target file

algorithm - digest algorithm (e.g. "SHA-256", "MD5")

forceFSSync - if true, forces OS cache flush to hardware storage

Returns:

lowercase hexadecimal hash string

Throws:

MissingArgumentException - if is, f, or algorithm is null

java.io.IOException

java.security.NoSuchAlgorithmException

getHashForFile

public static java.lang.String getHashForFile(java.lang.String algorithm,
                                              java.io.File f)
                                       throws java.security.NoSuchAlgorithmException,
                                              java.io.IOException

Computes the cryptographic checksum of a file.

Throws:

java.security.NoSuchAlgorithmException

java.io.IOException

getHashForBytes

public static java.lang.String getHashForBytes(java.lang.String algorithm,
                                               byte[] bytes)
                                        throws java.security.NoSuchAlgorithmException

Computes the cryptographic checksum of a raw byte array.

Throws:

java.security.NoSuchAlgorithmException

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os)
                 throws java.io.IOException

Throws:

java.io.IOException

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os,
                        boolean forceFSSync)
                 throws java.io.IOException

Throws:

java.io.IOException

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os,
                        boolean forceFSSync,
                        boolean closeOutputStream)
                 throws java.io.IOException

Throws:

java.io.IOException

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os,
                        boolean forceFSSync,
                        boolean closeOutputStream,
                        long maxlen)
                 throws java.io.IOException

Copies data from an InputStream to an OutputStream.

Caution: Closes is on completion or error. os is closed only if closeOutputStream is true.

Parameters:

is - source stream (always closed)

os - target stream

forceFSSync - forces hardware sync if os is a FileOutputStream

closeOutputStream - whether to close os upon completion

maxlen - maximum bytes to transfer

Returns:

total bytes transferred

Throws:

MissingArgumentException - if is or os is null

IncompleteTransferException - if the stream terminates prematurely before reaching maxlen

java.io.IOException - on general I/O errors

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os,
                        long maxlen)
                 throws java.io.IOException

Throws:

java.io.IOException

copy

public static long copy(java.io.InputStream is,
                        java.io.DataOutput os,
                        long maxlen)
                 throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File src,
                            java.io.File dst)
                     throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File src,
                            java.io.File dst,
                            boolean forceFSSync)
                     throws java.io.IOException

Copies a source file to a destination file.

Parameters:

src - source file

dst - destination file

forceFSSync - forces hardware storage synchronization

Throws:

MissingArgumentException - if src or dst is null

java.io.IOException

atomicMove

public static java.io.File atomicMove(java.io.File src,
                                      java.io.File dst)
                               throws java.io.IOException

Moves a file atomically within the same filesystem.

Throws:

MissingArgumentException - if src or dst is null

java.nio.file.AtomicMoveNotSupportedException - if atomic moves are unsupported across mounts

java.io.IOException

isAtomicMoveSupported

public static boolean isAtomicMoveSupported(java.io.File src,
                                            java.io.File dst)

Probes whether an atomic move can be performed between the locations of src and dst.

Creates transient probe files in both directory trees to verify mount point boundaries.

Parameters:

src - source directory/file location

dst - destination directory/file location

Returns:

true if atomic move is supported between both paths

getFilenameExtension

public static java.lang.String getFilenameExtension(java.lang.String filename)

getFilenameNamePart

public static java.lang.String getFilenameNamePart(java.lang.String filename)

splitFilenameAndExtension

public static java.lang.String[] splitFilenameAndExtension(java.lang.String filename)

Splits a filename into base name and lowercase extension.

Hidden files starting with a leading dot without a subsequent period (e.g. .bashrc) are treated as having no extension (base name intact, extension null).

Parameters:

filename - filename without path

Returns:

two-element array: [baseName, lowercaseExtensionOrNull]

isStandardIgnoreFilename

public static boolean isStandardIgnoreFilename(java.lang.String filename)

Checks if a filename matches default VCS and temporary backup patterns (e.g. RCS, CVS, .bak, .svn).

Parameters:

filename - bare filename without parent path elements

Returns:

true if filename matches standard ignore rules

isNonIgnoredFilenameWithOneOfSuffixes

public static boolean isNonIgnoredFilenameWithOneOfSuffixes(java.io.File f,
                                                            java.util.Collection<java.lang.String> suffixes)

Checks if the file is not ignored and matches one of the accepted extensions.

Parameters:

f - file to inspect

suffixes - collection of acceptable suffixes (e.g. [".java", ".nrx"]); if null or empty, all non-ignored files pass

Returns:

true if file is a non-directory, non-ignored file matching the suffix criteria

replaceInvalidFilenameChars

public static java.lang.String replaceInvalidFilenameChars(java.lang.String filename)

Replaces any character not matching [a-zA-Z0-9_\-] with an underscore.

Parameters:

filename - raw filename, may be null

Returns:

sanitized filename, or null

containsInvalidFilenameChars

public static boolean containsInvalidFilenameChars(java.lang.String filename)

Returns true if the filename contains characters outside [a-zA-Z0-9_\-].

Parameters:

filename - filename to check, may be null

Returns:

true if invalid characters are present, false otherwise or if null

getErrortextIfContainsInvalidFilenameChars

public static java.lang.String getErrortextIfContainsInvalidFilenameChars(java.lang.String filename,
                                                                          java.lang.String attributeName,
                                                                          java.lang.String boDescription)

Formats a localized error message if the filename contains invalid characters.

Parameters:

filename - filename to validate

attributeName - attribute name for the error message context

boDescription - business entity description (e.g. "Konto 4223")

Returns:

localized error message, or null if valid

Throws:

MissingArgumentException - if any parameter is null

open

public static boolean open(java.io.File f)

Opens the specified file with the desktop default application.

combineRelativePathsAsNeeded

public static java.lang.String combineRelativePathsAsNeeded(java.lang.String outerPath,
                                                            java.lang.String innerPath)

Combines and normalizes two relative path segments.

Example: "com/oashi/bo" + "../erp/Konto.java" → "com/oashi/erp/Konto.java"

Parameters:

outerPath - base relative path

innerPath - target relative path

Returns:

normalized system-independent relative path

Throws:

MissingArgumentException - if outerPath or innerPath is null

getFilenameFromPath

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

Extracts the terminal file name component from a path string.

packageToFilePath

public static java.lang.String packageToFilePath(java.lang.String packageName)

Translates a Java package identifier into a filesystem path (replaces dots with separators).

saveFile

public static void saveFile(byte[] bytes,
                            java.io.OutputStream fos)

Writes raw bytes to an OutputStream and closes it.

Caution: Consumes and closes fos regardless of success or failure.

Parameters:

bytes - data payload

fos - target stream (closed upon completion)

Throws:

MissingArgumentException - if fos or bytes is null

IRuntimeException - wrapping IOException

saveFile

public static void saveFile(java.lang.String content,
                            java.io.File f)

saveFile

public static void saveFile(java.lang.String content,
                            java.io.File f,
                            java.lang.String charsetName)

saveFile

public static void saveFile(java.lang.String content,
                            java.io.File f,
                            java.lang.String charsetName,
                            boolean forceFSSync)

saveFile

public static void saveFile(java.lang.String content,
                            java.io.File f,
                            java.lang.String charsetName,
                            boolean forceFSSync,
                            boolean append)

Saves string content to a file with optional hardware sync and append modes.

Parameters:

content - string to write

f - target file

charsetName - character encoding

forceFSSync - if true, invokes FileDescriptor.sync()

append - if true, appends instead of truncating existing file

Throws:

MissingArgumentException - if content, f, or charsetName is null

IRuntimeException - wrapping IOException or AccessDeniedException

saveFile

public static void saveFile(byte[] bytes,
                            java.io.File f)

saveFile

public static void saveFile(byte[] bytes,
                            java.io.File f,
                            boolean forceFSSync)

saveFile

public static void saveFile(byte[] bytes,
                            java.io.File f,
                            boolean forceFSSync,
                            boolean append)

saveFile

public static void saveFile(java.io.InputStream is,
                            java.io.File target)

saveFile

public static void saveFile(java.io.InputStream is,
                            java.io.File target,
                            boolean forceFSSync)

saveFile

public static void saveFile(java.io.InputStream is,
                            java.io.File target,
                            boolean forceFSSync,
                            boolean append)

Copies an InputStream to a target file.

Caution: Consumes and closes is on exit.

Parameters:

is - source stream (closed upon completion)

target - destination file

forceFSSync - if true, invokes FileDescriptor.sync()

append - if true, appends instead of truncating

Throws:

MissingArgumentException - if is or target is null

IRuntimeException - wrapping IOException