Package org.jf.util

Class ClassFileNameHandler

java.lang.Object

org.jf.util.ClassFileNameHandler

public class ClassFileNameHandler
extends Object

This class handles the complexities of translating a class name into a file name. i.e. dealing with case insensitive file systems, windows reserved filenames, class names with extremely long package/class elements, etc. The types of transformations this class does include: - append a '#123' style numeric suffix if 2 physical representations collide - replace some number of characters in the middle with a '#' character name if an individual path element is too long - append a '#' if an individual path element would otherwise be considered a reserved filename

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ClassFileNameHandler.DirectoryEntry
private class	ClassFileNameHandler.FileEntry
private class	ClassFileNameHandler.FileSystemEntry

Field Summary

Fields

Modifier and Type	Field	Description
private final int	CASE_INSENSITIVE
private final int	CASE_SENSITIVE
private String	fileExtension
private int	forcedCaseSensitivity
private static final int	MAX_FILENAME_LENGTH
private boolean	modifyWindowsReservedFilenames
private final int	NO_VALUE
private static final int	NUMERIC_SUFFIX_RESERVE
private static Pattern	reservedFileNameRegex
private ClassFileNameHandler.DirectoryEntry	top

Constructor Summary

Constructors

Constructor	Description
ClassFileNameHandler(File path, String fileExtension)
ClassFileNameHandler(File path, String fileExtension, boolean caseSensitive, boolean modifyWindowsReservedFilenames)

Method Summary

Modifier and Type	Method	Description
private static String	addSuffixBeforeExtension(String pathElement, String suffix)
private File	addUniqueChild(ClassFileNameHandler.DirectoryEntry parent, String[] packageElements, int packageElementIndex)
private int	getMaxFilenameLength()
File	getUniqueFilenameForClass(String className)
private static boolean	isReservedFileName(String className)
private static boolean	isWindows()
(package private) static String	shortenPathComponent(String pathComponent, int bytesToRemove)	Shortens an individual file/directory name, removing the necessary number of code points from the middle of the string such that the utf-8 encoding of the string is at least bytesToRemove bytes shorter than the original.
private static int	utf8Length(int codePoint)
private static int	utf8Length(String str)

Methods inherited from class java.lang.Object

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

Field Details

MAX_FILENAME_LENGTH

private static final int MAX_FILENAME_LENGTH

See Also:

• Constant Field Values

NUMERIC_SUFFIX_RESERVE

private static final int NUMERIC_SUFFIX_RESERVE

See Also:

• Constant Field Values

NO_VALUE

private final int NO_VALUE

See Also:

• Constant Field Values

CASE_INSENSITIVE

private final int CASE_INSENSITIVE

See Also:

• Constant Field Values

CASE_SENSITIVE

private final int CASE_SENSITIVE

See Also:

• Constant Field Values

forcedCaseSensitivity

private int forcedCaseSensitivity

top

private ClassFileNameHandler.DirectoryEntry top

fileExtension

private String fileExtension

modifyWindowsReservedFilenames

private boolean modifyWindowsReservedFilenames

reservedFileNameRegex

private static Pattern reservedFileNameRegex

Constructor Details

ClassFileNameHandler

public ClassFileNameHandler(File path,
 String fileExtension)

ClassFileNameHandler

public ClassFileNameHandler(File path,
 String fileExtension,
 boolean caseSensitive,
 boolean modifyWindowsReservedFilenames)

Method Details

getMaxFilenameLength

private int getMaxFilenameLength()

getUniqueFilenameForClass

public File getUniqueFilenameForClass(String className)
                               throws IOException

Throws:

IOException

addUniqueChild

@Nonnull
private File addUniqueChild(@Nonnull
 ClassFileNameHandler.DirectoryEntry parent,
 @Nonnull
 String[] packageElements,
 int packageElementIndex)
                     throws IOException

Throws:

IOException

utf8Length

private static int utf8Length(String str)

utf8Length

private static int utf8Length(int codePoint)

shortenPathComponent

@Nonnull
static String shortenPathComponent(@Nonnull
 String pathComponent,
 int bytesToRemove)

Shortens an individual file/directory name, removing the necessary number of code points from the middle of the string such that the utf-8 encoding of the string is at least bytesToRemove bytes shorter than the original. The removed codePoints in the middle of the string will be replaced with a # character.

isWindows

private static boolean isWindows()

isReservedFileName

private static boolean isReservedFileName(String className)

addSuffixBeforeExtension

private static String addSuffixBeforeExtension(String pathElement,
 String suffix)