FileTools

Object
- com.xilinx.rapidwright.util.FileTools

```
public class FileTools
extends Object
```
This class is specifically written to allow for efficient file import/export of different semi-primitive data types and structures. The read and write functions of this class are only guaranteed to work with those specified in this class and none else. The goal of this class is to load faster than Serialized Java and produce smaller files as well.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BINARY_CHECK_LENGTH`
`static String`	`CELL_PIN_DEFAULTS_FILE_NAME` Location of the cell pins default data file
`static String`	`DATA_FOLDER_NAME` Data folder name
`static String`	`DEVICE_CACHE_FILE_SUFFIX` Suffix of the device part files
`static String`	`DEVICE_FILE_SUFFIX` Suffix of the device part files
`static String`	`DEVICE_FOLDER_NAME` Folder where device files are kept
`static int[]`	`emptyIntArray` Static empty array to save on memory
`static short[]`	`emptyShortArray` Static empty array to save on memory
`static String[]`	`emptyStringArray` Static empty array to save on memory
`static int[]`	`GZIP_START_BYTES`
`static String`	`IMAGES_FOLDER_NAME` Images source folder name
`static String`	`JARS_FOLDER_NAME` Java library folder name
`static String`	`MD5_DATA_FILE_SUFFIX` Suffix added to data file names to capture md5 status
`static int`	`PART_DB_FILE_VERSION` Part Database File Version
`static String`	`PART_DB_PATH` Location of the main parts database file
`static String`	`PART_DUMP_FILE_NAME` File name created from Vivado for all supported parts for RapidWright
`static String`	`PYTHON_FOLDER_NAME` Python source folder name
`static String`	`RAPIDWRIGHT_DATA_URL` Base URL for download data files
`static String`	`RAPIDWRIGHT_VARIABLE_NAME` Environment Variable Name which points to the RapidWright project on disk
`static String`	`ROUTETHRU_FOLDER_NAME` Location of cached routethru helper files
`static String`	`TCL_FOLDER_NAME` Tcl source folder name
`static String`	`UNISIM_DATA_FILE_NAME` File name of the UnisimManager initialization data file (replaced HDI_PRIMITIVES_FILE_NAME and VALID_CELL_PLACEMENTS_FILE_NAME)
`static int`	`UNISIM_DATA_FILE_VERSION` Unisim Data File Version
`static String[]`	`UNPACK_FOLDERS` Supporting data folders packed in standalone jars of RapidWright

Constructor Summary

Constructors
Constructor and Description

FileTools()

Constructors
Constructor and Description
`FileTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Path`	`appendExtension(Path path, String extension)` Appends an extension to the file.
`static void`	`blockSystemExitCalls()` For Java 16 and below, calling this method will prevent System.exit() calls from exiting the JVM and instead throws a `SecurityException` in its place.
`static void`	`close(InputStream is)`
`static void`	`close(ZipFile zip)`
`static Path`	`compressFileUsingGZIP(Path uncompressedFile)` Compresses the provided file using GZIP (adds '.gz' extension)
`static boolean`	`copyFile(String src, String dst)` Copies a file from one location (src) to another (dst).
`static boolean`	`copyFolder(String srcDirectoryPath, String dstDirectoryPath, boolean recursive)` Copies a folder and its files from the path defined in srcDirectoryPath to a new folder at dstDirectoryPath.
`static boolean`	`copyFolderContents(String src, String dst, boolean recursive)` Copies the folder contents of the folder specified by src to folder specified as dst.
`static boolean`	`cygwinInstalled()` Checks if Cygwin is installed on the system
`static Path`	`decompressGZIPFile(Path gzipFile)` Decompresses a gzipped file to a file with the '.gz' extension removed.
`static boolean`	`deleteFile(String fileName)` Delete the file/folder in the file system called fileName
`static boolean`	`deleteFolder(String folderName)` Delete the folder and recursively files and folders below
`static boolean`	`deleteFolderContents(String path)` Deletes everything in the directory given by path, but does not delete the folder itself.
`static String`	`ensureCorrectDataFile(String name)` Ensures that the specified RapidWright data file is the correct version and present based on the MD5 hash in @link `DataVersions`
`static void`	`ensureDataFilesAreStaticInstallFriendly()` Downloads and generates all potential data files to make this RapidWright installation static friendly.
`static void`	`ensureDataFilesAreStaticInstallFriendly(String... devices)` Downloads and generates all potential data files to make this RapidWright installation static friendly.
`static void`	`errorIfFileDoesNotExist(String fileName)` Convenience assertion to assert that a file exists
`static List<String>`	`execCommandGetOutput(boolean includeError, String... command)` Runs the provided command (arguments must be separate) and gathers the standard output followed by the standard error.
`static void`	`forceUpdateAllDataFiles()` RapidWright downloads data files on demand to avoid large downloads.
`static List<String>`	`getAllDependentDataFiles(String... devices)` Gets the list of all relative dependent data files given the set of devices provided.
`static List<Path>`	`getAllFilesWithSuffix(Path root, String suffix)` Gets all files (Path objects) recursively (including all sub-directories) starting at a root directory of a particular extension (or file name suffix).
`static BufferedInputStream`	`getAutoBufferedInputStream(InputStream is)` Creates a new BufferedInputStream that wraps a possibly-compressed input stream.
`static List<FamilyType>`	`getAvailableFamilies()` This method returns an ArrayList of family types currently supported
`static List<String>`	`getAvailableParts(FamilyType type)` Checks for all device files present in the current RapidWright family path and returns a list of strings of those part names available to be used by the tool within the specified family.
`static ArrayList<String>`	`getCommandOutput(String[] command)` Generic method to run a command in the current shell and return its standard output and standard error
`static String`	`getContainerName(String fileName)` Translates RapidWright data file names to Azure Blob Container-friendly names
`static String`	`getCurrentDataVersion(String dataFileName)` Returns the expected MD5 sum of the named data file
`static FilenameFilter`	`getDCPFilenameFilter()` Gets a filename filter for DCP files (ends with .dcp).
`static Path`	`getDecompressedGZIPFileName(Path gzipFile)` Gets a Path to the corresponding uncompressed name of the provided path.
`static String`	`getDeviceFolderResourceName()`
`static String`	`getDeviceResourceCache(Part part)`
`static String`	`getDeviceResourceName(Part part)`
`static String`	`getDeviceResourceSuffix(Part part)`
`static String`	`getDirectorySeparator()` Gets and returns the file separator character for the given OS
`static FilenameFilter`	`getEDNFilenameFilter()` Gets a filename filter for EDN files (ends with .edn).
`static String`	`getExecJarStoragePath()`
`static FilenameFilter`	`getFilenameFilter(String matches)` Creates a custom filename filter that uses the provided matches string on the name of the file (not the path).
`static long`	`getFileSize(String fileName)` Gets the size of the file in bytes.
`static Pair<InputStream,Long>`	`getInputStreamFromZipFile(String zipFileName, String fileEndsWith)`
`static int`	`getJavaVersion()` Gets the current runtime version number.
`static com.esotericsoftware.kryo.io.Input`	`getKryoGzipInputStream(InputStream is)` Creates a Kryo input stream that decompresses a gzip compressed input stream.
`static com.esotericsoftware.kryo.io.Input`	`getKryoGzipInputStream(String fileName)` Creates a Kryo input stream that decompresses a gzip compressed input file.
`static com.esotericsoftware.kryo.io.Output`	`getKryoGzipOutputStream(OutputStream os)` Creates a Kryo output stream that instantiates a gzip compression stream to an output stream.
`static com.esotericsoftware.kryo.io.Output`	`getKryoGzipOutputStream(String fileName)` Creates a Kryo output stream that instantiates a gzip compression stream to an output file.
`static com.esotericsoftware.kryo.io.Input`	`getKryoInputStreamWithoutInflater(InputStream in)` Wraps the provided input stream with a kryo stream.
`static com.esotericsoftware.kryo.Kryo`	`getKryoInstance()`
`static com.esotericsoftware.kryo.io.Output`	`getKryoOutputStreamWithoutDeflater(OutputStream os)` Wraps the provided output stream with a kryo stream.
`static com.esotericsoftware.kryo.io.Input`	`getKryoZstdInputStream(InputStream input)` Creates a Kryo input stream from decompressing a Zstandard compressed input stream.
`static com.esotericsoftware.kryo.io.Input`	`getKryoZstdInputStream(String fileName)` Creates a Kryo input stream from decompressing Zstandard compressed input file.
`static com.esotericsoftware.kryo.io.Output`	`getKryoZstdOutputStream(OutputStream os)` Creates a Kryo output stream that instantiates a Zstandard compression stream from an output stream.
`static com.esotericsoftware.kryo.io.Output`	`getKryoZstdOutputStream(String fileName)` Creates a Kryo output stream that instantiates a Zstandard compression stream to an output file.
`static List<String>`	`getLastNLinesFromTextFile(String fileName, int n)` Gets the last n number of lines from a text file and returns them.
`static ArrayList<String>`	`getLinesFromInputStream(InputStream in)`
`static ArrayList<String>`	`getLinesFromTextFile(String fileName)` This is a simple method that will read in a text file and put each line in a string and put all the lines in an ArrayList.
`static String`	`getOSName()`
`static InputStream`	`getPartDumpResourceStream()` Gets an input stream to the file containing a CSV file of valid parts for RapidWright.
`static String`	`getPartFolderResourceName(FamilyType familyType)` Gets and returns the path of the folder where the family type resides.
`static String`	`getPartFolderResourceName(Part part)` Gets and returns the path of the folder where the part files resides for deviceName.
`static BufferedReader`	`getProperInputStream(String fileName)` Creates a BufferedReader that reads an input file and determines based on file extension (*.gz) if the file is gzipped or not.
`static BufferedWriter`	`getProperOutputStream(String fileName)` Creates a new BufferedWriter that will either write out text or a gzipped compressed version of text based on the file extension (*.gz `->` gzipped, all others target an uncompressed output.
`static String`	`getRapidWrightPath()` Gets and returns the value of the environment variable RAPIDWRIGHT_PATH.
`static String`	`getRapidWrightResourceFileName(String name)` Finds and returns a file name that can be read for the corresponding RapidWright resource.
`static InputStream`	`getRapidWrightResourceInputStream(String name)` Identifies the proper location for a RapidWright data resource and returns an opened InputStream to that resource.
`static String`	`getRouteThruFileName(String deviceName)` Gets the relative routethru file name for the given device.
`static String`	`getStoredMD5FromFile(Path md5File)` Extracts the md5 checksum from a previously created MD5 sum file.
`static String`	`getTimeStamp()` Creates a formatted string of the current time in a sortable format ("yyyy mm dd HH mm ss").
`static String`	`getTimeString()` This method will get and return the current time as a string formatted in the same way used in most Xilinx report and XDL files.
`static String`	`getUniqueProcessAndHostID()`
`static InputStream`	`getUnisimDataResourceStream()` Gets an input stream to the file containing valid cell placements of the hdi primitives.
`static String`	`getVivadoPath()` Gets the full path to the vivado executable if it is set in the PATH environment variable.
`static String`	`getVivadoVersion()` Gets the current version of Vivado on the system PATH.
`static InputStream`	`getZstdInputStream(String fileName)` Creates an input stream that decompresses a Zstandard compressed input file.
`static OutputStream`	`getZstdOutputStream(OutputStream os)` Wraps the provided output stream with a Zstandard compression stream.
`static OutputStream`	`getZstdOutputStream(String fileName)` Creates a Zstandard compression stream to an output file.
`static boolean`	`isDataBinary(InputStream is)`
`static boolean`	`isExecutableOnPath(String execName)` Checks if a particular executable is available on the current path
`static boolean`	`isFileBinary(Path fileName)` Uses a similar algorithm to diff to determine if the file is a binary file by looking at the first 4k bytes to see if there are any null characters.
`static boolean`	`isFileBinary(String fileName)` Uses a similar algorithm to diff to determine if the file is a binary file by looking at the first 4k bytes to see if there are any null characters.
`static boolean`	`isFileGzipped(Path path)`
`static boolean`	`isFileNewer(Path fileName1, Path fileName2)` Is fileName1 newer than fileName2?
`static boolean`	`isFileNewer(String fileName1, String fileName2)` Is fileName1 newer than fileName2?
`static boolean`	`isVivadoAtLeastVersion(int major, int minor)` Checks if Vivado is available and if it is available if it is at least of the version major.minor or later.
`static boolean`	`isVivadoCompatible()` Checks that Vivado is on current PATH and returns true if RapidWright should be compatible with the version of vivado available.
`static boolean`	`isVivadoOnPath()` Checks if vivado is available on current PATH (uses unix 'which' or windows 'where').
`static boolean`	`isWindows()`
`static Object`	`loadFromFile(String fileName)` Loads a serialized Java object from fileName.
`static void`	`main(String[] args)`
`static boolean`	`makeDir(String dirName)` Creates a directory in the current path called dirName.
`static boolean`	`makeDirs(String dirName)` Creates a directory in the current path called dirName.
`static boolean`	`overrideDataFileDownload()`
`static HashMap<String,Integer>`	`readHashMap(com.esotericsoftware.kryo.io.Input dis, Integer[] allInts)`
`static int[]`	`readIntArray(com.esotericsoftware.kryo.io.Input dis)`
`static Object`	`readObjectFromKryoFile(InputStream in)`
`static <T> T`	`readObjectFromKryoFile(InputStream in, Class<T> c)`
`static Object`	`readObjectFromKryoFile(Path fileName)`
`static <T> T`	`readObjectFromKryoFile(Path fileName, Class<T> c)`
`static Object`	`readObjectFromKryoFile(String fileName)`
`static <T> T`	`readObjectFromKryoFile(String fileName, Class<T> c)`
`static short[]`	`readShortArray(com.esotericsoftware.kryo.io.Input dis)`
`static String`	`readString(DataInputStream dis)`
`static String[]`	`readStringArray(com.esotericsoftware.kryo.io.Input dis)`
`static String`	`removeFileExtension(String fileName)` Takes a file name and removes everything after the last '.' inclusive
`static boolean`	`renameFile(String oldFileName, String newFileName)`
`static Path`	`replaceDir(Path path, Path newDir)`
`static Path`	`replaceExtension(Path path, String newExtension)` Replaces the file extension of the provided file name.
`static Integer`	`runCommand(List<String> command, String logFileName)` A generic method to run a command from the system command line.
`static Integer`	`runCommand(String command, boolean verbose)` A generic method to run a command from the system command line.
`static Integer`	`runCommand(String command, boolean verbose, String[] environ, File runDir)` A generic method to run a command from the system command line.
`static boolean`	`saveToFile(Object o, String fileName)` Serialize the Object o to a the file specified by fileName.
`static void`	`setOverrideDataFileDownload(boolean value)`
`static boolean`	`unPackSupportingJarData()` Used for unpacking data files inside a standalone jar to be used for regular use by RapidWright.
`static void`	`unzipFile(String zipFileName, String destDirectory)`
`static void`	`updateAllDataFiles()`
`static boolean`	`useUnsafeStreams()` Checks if Kryo Unsafe Streams can/should be used.
`static boolean`	`writeHashMap(com.esotericsoftware.kryo.io.Output dos, HashMap<String,Integer> map)`
`static boolean`	`writeIntArray(com.esotericsoftware.kryo.io.Output dos, int[] intArray)`
`static void`	`writeLinesToTextFile(List<String> lines, String fileName)` This is a simple method that writes the elements of an ArrayList of Strings into lines in the text file fileName.
`static void`	`writeObjectToKryoFile(Path fileName, Object o)`
`static void`	`writeObjectToKryoFile(Path fileName, Object o, boolean writeClass)`
`static void`	`writeObjectToKryoFile(String fileName, Object o)`
`static void`	`writeObjectToKryoFile(String fileName, Object o, boolean writeClass)`
`static boolean`	`writeShortArray(com.esotericsoftware.kryo.io.Output dos, short[] intArray)`
`static boolean`	`writeString(DataOutputStream dos, String str)`
`static boolean`	`writeStringArray(com.esotericsoftware.kryo.io.Output dos, String[] stringArray)`
`static void`	`writeStringToTextFile(String text, String fileName)` This is a simple method that writes a String to a file and adds a new line.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RAPIDWRIGHT_VARIABLE_NAME
```
public static final String RAPIDWRIGHT_VARIABLE_NAME
```
    Environment Variable Name which points to the RapidWright project on disk
    
    See Also:
    
    Constant Field Values
  - DEVICE_FILE_SUFFIX
```
public static final String DEVICE_FILE_SUFFIX
```
    Suffix of the device part files
    
    See Also:
    
    Constant Field Values
  - DEVICE_CACHE_FILE_SUFFIX
```
public static final String DEVICE_CACHE_FILE_SUFFIX
```
    Suffix of the device part files
    
    See Also:
    
    Constant Field Values
  - DATA_FOLDER_NAME
```
public static final String DATA_FOLDER_NAME
```
    Data folder name
    
    See Also:
    
    Constant Field Values
  - TCL_FOLDER_NAME
```
public static final String TCL_FOLDER_NAME
```
    Tcl source folder name
    
    See Also:
    
    Constant Field Values
  - JARS_FOLDER_NAME
```
public static final String JARS_FOLDER_NAME
```
    Java library folder name
    
    See Also:
    
    Constant Field Values
  - IMAGES_FOLDER_NAME
```
public static final String IMAGES_FOLDER_NAME
```
    Images source folder name
    
    See Also:
    
    Constant Field Values
  - PYTHON_FOLDER_NAME
```
public static final String PYTHON_FOLDER_NAME
```
    Python source folder name
    
    See Also:
    
    Constant Field Values
  - DEVICE_FOLDER_NAME
```
public static final String DEVICE_FOLDER_NAME
```
    Folder where device files are kept
  - UNISIM_DATA_FILE_NAME
```
public static final String UNISIM_DATA_FILE_NAME
```
    File name of the UnisimManager initialization data file (replaced HDI_PRIMITIVES_FILE_NAME and VALID_CELL_PLACEMENTS_FILE_NAME)
  - PART_DUMP_FILE_NAME
```
public static final String PART_DUMP_FILE_NAME
```
    File name created from Vivado for all supported parts for RapidWright
  - PART_DB_PATH
```
public static final String PART_DB_PATH
```
    Location of the main parts database file
  - CELL_PIN_DEFAULTS_FILE_NAME
```
public static final String CELL_PIN_DEFAULTS_FILE_NAME
```
    Location of the cell pins default data file
  - ROUTETHRU_FOLDER_NAME
```
public static final String ROUTETHRU_FOLDER_NAME
```
    Location of cached routethru helper files
  - UNPACK_FOLDERS
```
public static final String[] UNPACK_FOLDERS
```
    Supporting data folders packed in standalone jars of RapidWright
  - emptyIntArray
```
public static int[] emptyIntArray
```
    Static empty array to save on memory
  - emptyShortArray
```
public static short[] emptyShortArray
```
    Static empty array to save on memory
  - emptyStringArray
```
public static String[] emptyStringArray
```
    Static empty array to save on memory
  - PART_DB_FILE_VERSION
```
public static final int PART_DB_FILE_VERSION
```
    Part Database File Version
    
    See Also:
    
    Constant Field Values
  - UNISIM_DATA_FILE_VERSION
```
public static final int UNISIM_DATA_FILE_VERSION
```
    Unisim Data File Version
    
    See Also:
    
    Constant Field Values
  - RAPIDWRIGHT_DATA_URL
```
public static final String RAPIDWRIGHT_DATA_URL
```
    Base URL for download data files
    
    See Also:
    
    Constant Field Values
  - MD5_DATA_FILE_SUFFIX
```
public static final String MD5_DATA_FILE_SUFFIX
```
    Suffix added to data file names to capture md5 status
    
    See Also:
    
    Constant Field Values
  - BINARY_CHECK_LENGTH
```
public static final int BINARY_CHECK_LENGTH
```
    See Also:
    
    Constant Field Values
  - GZIP_START_BYTES
```
public static final int[] GZIP_START_BYTES
```
- Constructor Detail
  - FileTools
```
public FileTools()
```
- Method Detail
  - getKryoZstdOutputStream
```
public static com.esotericsoftware.kryo.io.Output getKryoZstdOutputStream(String fileName)
```
    Creates a Kryo output stream that instantiates a Zstandard compression stream to an output file.
    
    Parameters:
    
    fileName - Name of the file to target.
    
    Returns:
    
    The created kryo-zstd output file stream.
  - getKryoZstdOutputStream
```
public static com.esotericsoftware.kryo.io.Output getKryoZstdOutputStream(OutputStream os)
```
    Creates a Kryo output stream that instantiates a Zstandard compression stream from an output stream.
    
    Parameters:
    
    os - The existing output stream to wrap.
    
    Returns:
    
    The created kryo-zstd output file stream.
  - getZstdOutputStream
```
public static OutputStream getZstdOutputStream(String fileName)
```
    Creates a Zstandard compression stream to an output file.
    
    Parameters:
    
    fileName - Name of the file to target.
    
    Returns:
    
    The created zstd output file stream.
  - getZstdOutputStream
```
public static OutputStream getZstdOutputStream(OutputStream os)
```
    Wraps the provided output stream with a Zstandard compression stream.
    
    Parameters:
    
    os - The existing output stream.
    
    Returns:
    
    The new output stream that will use Zstandard compression.
  - getKryoGzipOutputStream
```
public static com.esotericsoftware.kryo.io.Output getKryoGzipOutputStream(String fileName)
```
    Creates a Kryo output stream that instantiates a gzip compression stream to an output file.
    
    Parameters:
    
    fileName - Name of the file to target.
    
    Returns:
    
    The created kryo-gzip output file stream.
  - getKryoGzipOutputStream
```
public static com.esotericsoftware.kryo.io.Output getKryoGzipOutputStream(OutputStream os)
```
    Creates a Kryo output stream that instantiates a gzip compression stream to an output stream.
    
    Parameters:
    
    os - The output stream to wrap.
    
    Returns:
    
    The created kryo-gzip output file stream.
  - getKryoOutputStreamWithoutDeflater
```
public static com.esotericsoftware.kryo.io.Output getKryoOutputStreamWithoutDeflater(OutputStream os)
```
    Wraps the provided output stream with a kryo stream. Will call FileTools.useUnsafeStreams() to decide on using unsafe or not.
    
    Parameters:
    
    os - The output stream to wrap.
    
    Returns:
    
    The created kryo stream.
  - getKryoZstdInputStream
```
public static com.esotericsoftware.kryo.io.Input getKryoZstdInputStream(String fileName)
```
    Creates a Kryo input stream from decompressing Zstandard compressed input file.
    
    Parameters:
    
    fileName - Name of the file to read from.
    
    Returns:
    
    The created kryo-zstd input file stream.
  - getKryoZstdInputStream
```
public static com.esotericsoftware.kryo.io.Input getKryoZstdInputStream(InputStream input)
```
    Creates a Kryo input stream from decompressing a Zstandard compressed input stream.
    
    Parameters:
    
    input - The input stream to read from.
    
    Returns:
    
    The created kryo-zstd input file stream.
  - getZstdInputStream
```
public static InputStream getZstdInputStream(String fileName)
```
    Creates an input stream that decompresses a Zstandard compressed input file.
    
    Parameters:
    
    fileName - Name of the file to read from.
    
    Returns:
    
    The created zstd input file stream.
  - getKryoGzipInputStream
```
public static com.esotericsoftware.kryo.io.Input getKryoGzipInputStream(String fileName)
```
    Creates a Kryo input stream that decompresses a gzip compressed input file.
    
    Parameters:
    
    fileName - Name of the file read from.
    
    Returns:
    
    The created kryo-gzip input file stream.
  - getKryoGzipInputStream
```
public static com.esotericsoftware.kryo.io.Input getKryoGzipInputStream(InputStream is)
```
    Creates a Kryo input stream that decompresses a gzip compressed input stream.
    
    Parameters:
    
    is - The gzip compressed input stream to read from.
    
    Returns:
    
    The created kryo-gzip input file stream.
  - getKryoInputStreamWithoutInflater
```
public static com.esotericsoftware.kryo.io.Input getKryoInputStreamWithoutInflater(InputStream in)
```
    Wraps the provided input stream with a kryo stream. Will call FileTools.useUnsafeStreams() to decide on using unsafe or not.
    
    Parameters:
    
    in - The input stream to wrap.
    
    Returns:
    
    The created kryo stream.
  - getAutoBufferedInputStream
```
public static BufferedInputStream getAutoBufferedInputStream(InputStream is)
                                                      throws IOException
```
    Creates a new BufferedInputStream that wraps a possibly-compressed input stream. The first 4 bytes of the input stream are examined for the presence of the Zstandard magic number and if found, will be decompressed prior to wrapping.
    
    Parameters:
    
    is - The input stream to wrap.
    
    Returns:
    
    The created BufferedInputStream.
    
    Throws:
    
    IOException
  - useUnsafeStreams
```
public static boolean useUnsafeStreams()
```
    Checks if Kryo Unsafe Streams can/should be used. They provide a performance advantage but are not (as easily) available in Java 16+.
    
    Returns:
    
    True if unsafe streams are to be used, false otherwise.
  - getJavaVersion
```
public static int getJavaVersion()
```
    Gets the current runtime version number. Correctly handles 1.8.x formats and Java 9+
    
    Returns:
    
    The integer version of the Java version (8, 9, 10, 11, ...)
  - getProperInputStream
```
public static BufferedReader getProperInputStream(String fileName)
```
    Creates a BufferedReader that reads an input file and determines based on file extension (*.gz) if the file is gzipped or not.
    
    Parameters:
    
    fileName - Name of the text or gzipped file
    
    Returns:
    
    An opened BufferedReader to the file.
  - getProperOutputStream
```
public static BufferedWriter getProperOutputStream(String fileName)
```
    Creates a new BufferedWriter that will either write out text or a gzipped compressed version of text based on the file extension (*.gz -> gzipped, all others target an uncompressed output.
    
    Parameters:
    
    fileName - Name of the output file. Will be gzipped if has *.gz extension.
    
    Returns:
    
    The opened BufferedWriter to the named file.
  - readHashMap
```
public static HashMap<String,Integer> readHashMap(com.esotericsoftware.kryo.io.Input dis,
                                                  Integer[] allInts)
```
  - writeHashMap
```
public static boolean writeHashMap(com.esotericsoftware.kryo.io.Output dos,
                                   HashMap<String,Integer> map)
```
  - writeStringArray
```
public static boolean writeStringArray(com.esotericsoftware.kryo.io.Output dos,
                                       String[] stringArray)
```
  - readStringArray
```
public static String[] readStringArray(com.esotericsoftware.kryo.io.Input dis)
```
  - writeIntArray
```
public static boolean writeIntArray(com.esotericsoftware.kryo.io.Output dos,
                                    int[] intArray)
```
  - writeShortArray
```
public static boolean writeShortArray(com.esotericsoftware.kryo.io.Output dos,
                                      short[] intArray)
```
  - readIntArray
```
public static int[] readIntArray(com.esotericsoftware.kryo.io.Input dis)
```
  - readShortArray
```
public static short[] readShortArray(com.esotericsoftware.kryo.io.Input dis)
```
  - writeString
```
public static boolean writeString(DataOutputStream dos,
                                  String str)
```
  - readString
```
public static String readString(DataInputStream dis)
```
  - loadFromFile
```
public static Object loadFromFile(String fileName)
```
    Loads a serialized Java object from fileName.
    
    Parameters:
    
    fileName - The file to read from.
    
    Returns:
    
    The Object de-serialized from the file or null if there was an error.
  - saveToFile
```
public static boolean saveToFile(Object o,
                                 String fileName)
```
    Serialize the Object o to a the file specified by fileName.
    
    Parameters:
    
    o - The object to serialize.
    
    fileName - Name of the file to serialize the object to.
    
    Returns:
    
    True if operation was successful, false otherwise.
  - writeLinesToTextFile
```
public static void writeLinesToTextFile(List<String> lines,
                                        String fileName)
```
    This is a simple method that writes the elements of an ArrayList of Strings into lines in the text file fileName.
    
    Parameters:
    
    lines - The ArrayList of Strings to be written
    
    fileName - Name of the text file to save the ArrayList to
  - writeStringToTextFile
```
public static void writeStringToTextFile(String text,
                                         String fileName)
```
    This is a simple method that writes a String to a file and adds a new line.
    
    Parameters:
    
    text - the String to write to the file
    
    fileName - Name of the text file to save the ArrayList to
  - getLinesFromTextFile
```
public static ArrayList<String> getLinesFromTextFile(String fileName)
```
    This is a simple method that will read in a text file and put each line in a string and put all the lines in an ArrayList. The user is cautioned not to open extremely large files with this method.
    
    Parameters:
    
    fileName - Name of the text file to load.
    
    Returns:
    
    An ArrayList containing strings of each line in the file.
  - getLastNLinesFromTextFile
```
public static List<String> getLastNLinesFromTextFile(String fileName,
                                                     int n)
```
    Gets the last n number of lines from a text file and returns them.
    
    Parameters:
    
    fileName - Name of the text file
    
    n - Number of last lines to get
    
    Returns:
    
    A list of the last n lines in the text file. If the file has less than or equal to n lines in the file, it returns all lines in the file.
  - getLinesFromInputStream
```
public static ArrayList<String> getLinesFromInputStream(InputStream in)
```
  - removeFileExtension
```
public static String removeFileExtension(String fileName)
```
    Takes a file name and removes everything after the last '.' inclusive
    
    Parameters:
    
    fileName - The input file name
    
    Returns:
    
    the substring of fileName if it contains a '.', it returns fileName otherwise
  - makeDir
```
public static boolean makeDir(String dirName)
```
    Creates a directory in the current path called dirName.
    
    Parameters:
    
    dirName - Name of the directory to be created.
    
    Returns:
    
    True if the directory was created or already exists, false otherwise.
  - makeDirs
```
public static boolean makeDirs(String dirName)
```
    Creates a directory in the current path called dirName.
    
    Parameters:
    
    dirName - Name of the directory to be created.
    
    Returns:
    
    True if the directory and implicit parent directories were created, false otherwise.
  - getFileSize
```
public static long getFileSize(String fileName)
```
    Gets the size of the file in bytes.
    
    Parameters:
    
    fileName - Name of the file to get the size of.
    
    Returns:
    
    The number of bytes used by the file.
  - deleteFile
```
public static boolean deleteFile(String fileName)
```
    Delete the file/folder in the file system called fileName
    
    Parameters:
    
    fileName - Name of the file to delete
    
    Returns:
    
    True for successful deletion, false otherwise.
  - deleteFolderContents
```
public static boolean deleteFolderContents(String path)
```
    Deletes everything in the directory given by path, but does not delete the folder itself.
    
    Parameters:
    
    path - The path to the folder where all its contents will be deleted.
    
    Returns:
    
    True if operation was successful, false otherwise.
  - deleteFolder
```
public static boolean deleteFolder(String folderName)
```
    Delete the folder and recursively files and folders below
    
    Parameters:
    
    folderName -
    
    Returns:
    
    true for successful deletion, false otherwise
  - renameFile
```
public static boolean renameFile(String oldFileName,
                                 String newFileName)
```
  - copyFile
```
public static boolean copyFile(String src,
                               String dst)
```
    Copies a file from one location (src) to another (dst). This implementation uses the java.nio channels (because supposedly it is faster).
    
    Parameters:
    
    src - Source file to read from
    
    dst - Destination file to write to
    
    Returns:
    
    True if operation was successful, false otherwise.
  - copyFolder
```
public static boolean copyFolder(String srcDirectoryPath,
                                 String dstDirectoryPath,
                                 boolean recursive)
```
    Copies a folder and its files from the path defined in srcDirectoryPath to a new folder at dstDirectoryPath. If the recursive flag is set it will also recursively copy subfolders from the source to the destination.
    
    Parameters:
    
    srcDirectoryPath - The name of the source folder to copy.
    
    dstDirectoryPath - The destination of where the copy of the folder should be located.
    
    recursive - A flag denoting if the sub folders of source should be copied.
    
    Returns:
    
    True if operation was successful, false otherwise.
  - copyFolderContents
```
public static boolean copyFolderContents(String src,
                                         String dst,
                                         boolean recursive)
```
    Copies the folder contents of the folder specified by src to folder specified as dst. It will copy all files in it to the new location. If the recursive flag is set, it will copy everything recursively in the folder src to dst.
    
    Parameters:
    
    src - The source folder to copy.
    
    dst - The location of where the copy of the contents of src will be located.
    
    recursive - A flag indicating if sub folders and their contents should be copied.
    
    Returns:
    
    True if operation is successful, false otherwise.
  - errorIfFileDoesNotExist
```
public static void errorIfFileDoesNotExist(String fileName)
```
    Convenience assertion to assert that a file exists
    
    Parameters:
    
    fileName - Name of the file to check
  - getRapidWrightPath
```
public static String getRapidWrightPath()
```
    Gets and returns the value of the environment variable RAPIDWRIGHT_PATH. If this variable is not set, it searches the file system from where the RapidWright code is located and checks if the data directory is present if it is, then it returns the full path name of the directory containing /data. If not (such as when running from a jar file) it returns null.
    
    Returns:
    
    The string of the path to the RapidWright, or null if running from within a jar file and RAPIDWRIGHT_PATH is not set.
  - getExecJarStoragePath
```
public static String getExecJarStoragePath()
```
  - updateAllDataFiles
```
public static void updateAllDataFiles()
```
  - forceUpdateAllDataFiles
```
public static void forceUpdateAllDataFiles()
```
    RapidWright downloads data files on demand to avoid large downloads. However, if a user wishes to download all necessary files upfront, this method will download and update all necessary files.
  - ensureDataFilesAreStaticInstallFriendly
```
public static void ensureDataFilesAreStaticInstallFriendly(String... devices)
```
    Downloads and generates all potential data files to make this RapidWright installation static friendly. After running this method, RapidWright should not download any files, create any new directories or generate any new files. This is useful when a single RapidWright installation will be used by multiple processes simultaneously and/or when RapidWright needs to reside in a read-only space.
    
    Parameters:
    
    devices - The set of devices intended to be used for this installation (this simply saves download and generation time).
  - ensureDataFilesAreStaticInstallFriendly
```
public static void ensureDataFilesAreStaticInstallFriendly()
```
    Downloads and generates all potential data files to make this RapidWright installation static friendly. After running this method, RapidWright should not download any files, create any new directories or generate any new files. This is useful when a single RapidWright installation will be used by multiple processes simultaneously and/or when RapidWright needs to reside in a read-only space. This method will download all devices files and generate all cache files for each device.
  - getAllDependentDataFiles
```
public static List<String> getAllDependentDataFiles(String... devices)
```
    Gets the list of all relative dependent data files given the set of devices provided.
    
    Parameters:
    
    devices - The list of devices to be used to compile the list of needed data files.
    
    Returns:
    
    The list of all necessary data files to operate RapidWright independently from downloads or generating cache files.
  - ensureCorrectDataFile
```
public static String ensureCorrectDataFile(String name)
```
    Ensures that the specified RapidWright data file is the correct version and present based on the MD5 hash in @link DataVersions
    
    Parameters:
    
    name - Name of the RapidWright data file resource
    
    Returns:
    
    The MD5 hash of a downloaded file, null if the file present is the correct version
  - getStoredMD5FromFile
```
public static String getStoredMD5FromFile(Path md5File)
```
    Extracts the md5 checksum from a previously created MD5 sum file.
    
    Parameters:
    
    md5File - The path of the existing md5 sum file
    
    Returns:
    
    the md5 checksum found in the file or null if no file existed or couldn't be read.
  - getRapidWrightResourceInputStream
```
public static InputStream getRapidWrightResourceInputStream(String name)
```
    Identifies the proper location for a RapidWright data resource and returns an opened InputStream to that resource. This works regardless if RAPIDWRIGHT_PATH is set or not, if the resource is inside a jar or not.
    
    Parameters:
    
    name - Name of the resource.
    
    Returns:
    
    An InputStream to the resource or null if it could not be found.
  - getRapidWrightResourceFileName
```
public static String getRapidWrightResourceFileName(String name)
```
    Finds and returns a file name that can be read for the corresponding RapidWright resource.
    
    Parameters:
    
    name - Name of the RapidWright resource
    
    Returns:
    
    The full file name path, or null if one could not be found.
  - getUnisimDataResourceStream
```
public static InputStream getUnisimDataResourceStream()
```
    Gets an input stream to the file containing valid cell placements of the hdi primitives.
    
    Returns:
    
    An input stream to the valid cell placements map file.
  - getPartDumpResourceStream
```
public static InputStream getPartDumpResourceStream()
```
    Gets an input stream to the file containing a CSV file of valid parts for RapidWright.
    
    Returns:
    
    An input stream to the valid cell placements map file.
  - getPartFolderResourceName
```
public static String getPartFolderResourceName(Part part)
```
    Gets and returns the path of the folder where the part files resides for deviceName.
    
    Parameters:
    
    part - The part to get its corresponding folder path.
    
    Returns:
    
    The path of the folder where the parts files resides.
  - getPartFolderResourceName
```
public static String getPartFolderResourceName(FamilyType familyType)
```
    Gets and returns the path of the folder where the family type resides.
    
    Parameters:
    
    familyType - The family type corresponding folder path.
    
    Returns:
    
    The path of the folder where the parts of familyType reside.
  - getDeviceFolderResourceName
```
public static String getDeviceFolderResourceName()
```
  - getDeviceResourceName
```
public static String getDeviceResourceName(Part part)
```
  - getDeviceResourceSuffix
```
public static String getDeviceResourceSuffix(Part part)
```
  - getDeviceResourceCache
```
public static String getDeviceResourceCache(Part part)
```
  - getRouteThruFileName
```
public static String getRouteThruFileName(String deviceName)
```
    Gets the relative routethru file name for the given device.
    
    Parameters:
    
    deviceName - Name of the device
    
    Returns:
    
    Relative routethru data file name for the given device.
  - getAvailableParts
```
public static List<String> getAvailableParts(FamilyType type)
```
    Checks for all device files present in the current RapidWright family path and returns a list of strings of those part names available to be used by the tool within the specified family.
    
    Parameters:
    
    type - The specified family type.
    
    Returns:
    
    A list of available Xilinx parts for the given family type
  - getAvailableFamilies
```
public static List<FamilyType> getAvailableFamilies()
```
    This method returns an ArrayList of family types currently supported
    
    Returns:
    
    ArrayList of all family types installed
  - getTimeString
```
public static String getTimeString()
```
    This method will get and return the current time as a string formatted in the same way used in most Xilinx report and XDL files. The format used in the using the same syntax as SimpleDateFormat which is "EEE MMM dd HH:mm:ss z yyyy".
    
    Returns:
    
    Current date and time as a formatted string.
  - getTimeStamp
```
public static String getTimeStamp()
```
    Creates a formatted string of the current time in a sortable format ("yyyy mm dd HH mm ss").
    
    Returns:
    
    The time stamp as a sortable string.
  - getDirectorySeparator
```
public static String getDirectorySeparator()
```
    Gets and returns the file separator character for the given OS
  - cygwinInstalled
```
public static boolean cygwinInstalled()
```
    Checks if Cygwin is installed on the system
  - writeObjectToKryoFile
```
public static void writeObjectToKryoFile(Path fileName,
                                         Object o)
```
  - writeObjectToKryoFile
```
public static void writeObjectToKryoFile(String fileName,
                                         Object o)
```
  - writeObjectToKryoFile
```
public static void writeObjectToKryoFile(Path fileName,
                                         Object o,
                                         boolean writeClass)
```
  - writeObjectToKryoFile
```
public static void writeObjectToKryoFile(String fileName,
                                         Object o,
                                         boolean writeClass)
```
  - readObjectFromKryoFile
```
public static Object readObjectFromKryoFile(String fileName)
```
  - readObjectFromKryoFile
```
public static Object readObjectFromKryoFile(Path fileName)
```
  - readObjectFromKryoFile
```
public static <T> T readObjectFromKryoFile(String fileName,
                                           Class<T> c)
```
  - readObjectFromKryoFile
```
public static <T> T readObjectFromKryoFile(Path fileName,
                                           Class<T> c)
```
  - readObjectFromKryoFile
```
public static <T> T readObjectFromKryoFile(InputStream in,
                                           Class<T> c)
```
  - readObjectFromKryoFile
```
public static Object readObjectFromKryoFile(InputStream in)
```
  - getKryoInstance
```
public static com.esotericsoftware.kryo.Kryo getKryoInstance()
```
  - isFileNewer
```
public static boolean isFileNewer(Path fileName1,
                                  Path fileName2)
```
    Is fileName1 newer than fileName2?
    
    Parameters:
    
    fileName1 -
    
    fileName2 -
    
    Returns:
  - isFileNewer
```
public static boolean isFileNewer(String fileName1,
                                  String fileName2)
```
    Is fileName1 newer than fileName2?
    
    Parameters:
    
    fileName1 -
    
    fileName2 -
    
    Returns:
  - getInputStreamFromZipFile
```
public static Pair<InputStream,Long> getInputStreamFromZipFile(String zipFileName,
                                                               String fileEndsWith)
```
  - close
```
public static void close(InputStream is)
```
  - close
```
public static void close(ZipFile zip)
```
  - getCommandOutput
```
public static ArrayList<String> getCommandOutput(String[] command)
```
    Generic method to run a command in the current shell and return its standard output and standard error
    
    Parameters:
    
    command - The command to run
    
    Returns:
    
    A list of standard output lines followed by the standard error lines
  - runCommand
```
public static Integer runCommand(String command,
                                 boolean verbose)
```
    A generic method to run a command from the system command line.
    
    Parameters:
    
    command - The command to execute. This method blocks until the command finishes.
    
    verbose - When true, it will first print to std.out the command and also all of the command's output (both std.out and std.err) to std.out.
    
    Returns:
    
    The return value of the process if it terminated, if there was a problem it returns null.
  - runCommand
```
public static Integer runCommand(String command,
                                 boolean verbose,
                                 String[] environ,
                                 File runDir)
```
    A generic method to run a command from the system command line.
    
    Parameters:
    
    command - The command to execute. This method blocks until the command finishes.
    
    verbose - When true, it will first print to std.out the command and also all of the command's output (both std.out and std.err) to std.out.
    
    environ - array of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.
    
    runDir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
    
    Returns:
    
    The return value of the process if it terminated, if there was a problem it returns null.
  - runCommand
```
public static Integer runCommand(List<String> command,
                                 String logFileName)
```
    A generic method to run a command from the system command line.
    
    Parameters:
    
    command - The command to execute. This method blocks until the command finishes.
    
    logFileName - Name of the log file to produce that will capture stderr and stdout.
    
    Returns:
    
    The return value of the process if it terminated, if there was a problem it returns null.
  - getUniqueProcessAndHostID
```
public static String getUniqueProcessAndHostID()
```
  - isFileBinary
```
public static boolean isFileBinary(Path fileName)
```
    Uses a similar algorithm to diff to determine if the file is a binary file by looking at the first 4k bytes to see if there are any null characters. If so, it is considered binary.
    
    Parameters:
    
    fileName - Name of the file to check.
    
    Returns:
    
    True if the file is considered binary, false otherwise.
  - isFileBinary
```
public static boolean isFileBinary(String fileName)
```
    Uses a similar algorithm to diff to determine if the file is a binary file by looking at the first 4k bytes to see if there are any null characters. If so, it is considered binary.
    
    Parameters:
    
    fileName - Name of the file to check.
    
    Returns:
    
    True if the file is considered binary, false otherwise.
  - isDataBinary
```
public static boolean isDataBinary(InputStream is)
```
  - isFileGzipped
```
public static boolean isFileGzipped(Path path)
```
  - execCommandGetOutput
```
public static List<String> execCommandGetOutput(boolean includeError,
                                                String... command)
```
    Runs the provided command (arguments must be separate) and gathers the standard output followed by the standard error.
    
    Parameters:
    
    includeError - Option to set if the returned list includes the standard error at the end.
    
    command - The command with arguments separated.
    
    Returns:
    
    The list of lines of output from the command.
  - isExecutableOnPath
```
public static boolean isExecutableOnPath(String execName)
```
    Checks if a particular executable is available on the current path
    
    Parameters:
    
    execName - Name of the executable (ex: vivado)
    
    Returns:
    
    True if the executable is available in the current path, false otherwise.
  - isVivadoOnPath
```
public static boolean isVivadoOnPath()
```
    Checks if vivado is available on current PATH (uses unix 'which' or windows 'where').
    
    Returns:
    
    true if vivado is on current PATH, false otherwise.
  - isVivadoCompatible
```
public static boolean isVivadoCompatible()
```
    Checks that Vivado is on current PATH and returns true if RapidWright should be compatible with the version of vivado available. Vivado versions that match or are older than RapidWright are presumed compatible.
  - isVivadoAtLeastVersion
```
public static boolean isVivadoAtLeastVersion(int major,
                                             int minor)
```
    Checks if Vivado is available and if it is available if it is at least of the version major.minor or later.
    
    Parameters:
    
    major - The major Vivado version (generally the year)
    
    minor - The minor Vivado version
    
    Returns:
    
    True if Vivado is available and meets the version requirements, false otherwise.
  - getVivadoVersion
```
public static String getVivadoVersion()
```
    Gets the current version of Vivado on the system PATH.
    
    Returns:
    
    The string version representation of the Vivado version available on the system PATH.
  - getVivadoPath
```
public static String getVivadoPath()
```
    Gets the full path to the vivado executable if it is set in the PATH environment variable. Works for Windows and Linux.
    
    Returns:
    
    Full path to vivado executable, or throws RuntimeException if not found.
  - getOSName
```
public static String getOSName()
```
  - isWindows
```
public static boolean isWindows()
```
  - unzipFile
```
public static void unzipFile(String zipFileName,
                             String destDirectory)
```
  - getEDNFilenameFilter
```
public static FilenameFilter getEDNFilenameFilter()
```
    Gets a filename filter for EDN files (ends with .edn).
    
    Returns:
    
    The EDN filename filter
  - getDCPFilenameFilter
```
public static FilenameFilter getDCPFilenameFilter()
```
    Gets a filename filter for DCP files (ends with .dcp).
    
    Returns:
    
    The DCP filename filter
  - getFilenameFilter
```
public static FilenameFilter getFilenameFilter(String matches)
```
    Creates a custom filename filter that uses the provided matches string on the name of the file (not the path).
    
    Parameters:
    
    matches - Uses the String.matches() to match filename.
    
    Returns:
    
    The newly created filename filter object.
  - unPackSupportingJarData
```
public static boolean unPackSupportingJarData()
```
    Used for unpacking data files inside a standalone jar to be used for regular use by RapidWright.
    
    Returns:
    
    True if operation succeeds, false otherwise.
  - appendExtension
```
public static Path appendExtension(Path path,
                                   String extension)
```
    Appends an extension to the file. if there is already an extension, the result will have two extensions.
    
    Parameters:
    
    path -
    
    extension -
    
    Returns:
  - replaceExtension
```
public static Path replaceExtension(Path path,
                                    String newExtension)
```
    Replaces the file extension of the provided file name. The current extension includes the final period '.' and all characters following it. If the file has no extension, it will add it as a suffix to the filename.
    
    Parameters:
    
    path - Name of the file to receive the updated extension.
    
    newExtension - The new extension (should include starting period '.')
    
    Returns:
    
    The newly updated file path.
  - getContainerName
```
public static String getContainerName(String fileName)
```
    Translates RapidWright data file names to Azure Blob Container-friendly names
    
    Parameters:
    
    fileName - Name of the RapidWright data file
    
    Returns:
    
    Azure blob container name for the provided RapidWright data file
  - getCurrentDataVersion
```
public static String getCurrentDataVersion(String dataFileName)
```
    Returns the expected MD5 sum of the named data file
    
    Parameters:
    
    dataFileName - Name of the RapidWright data file name (for example: data/devices/artix7/xa7a100t_db.dat)
    
    Returns:
    
    The MD5 sum of the expected file contents.
  - setOverrideDataFileDownload
```
public static void setOverrideDataFileDownload(boolean value)
```
  - overrideDataFileDownload
```
public static boolean overrideDataFileDownload()
```
  - getAllFilesWithSuffix
```
public static List<Path> getAllFilesWithSuffix(Path root,
                                               String suffix)
```
    Gets all files (Path objects) recursively (including all sub-directories) starting at a root directory of a particular extension (or file name suffix). This tries to use the native Linux 'find' command if available as it is 4-5X faster than the Java Files.walk() method. Otherwise it defaults to using the conventional Files.walk() approach.
    
    Parameters:
    
    root - The root directory from which to start the query
    
    suffix - The file name extension (or suffix pattern) of the files to get
    
    Returns:
    
    A list of all files found in the directory and all sub-directories with the provided suffix (extension)
  - blockSystemExitCalls
```
public static void blockSystemExitCalls()
```
    For Java 16 and below, calling this method will prevent System.exit() calls from exiting the JVM and instead throws a SecurityException in its place. This method allows for a check to avoid the JVM WARNING message in Java 17.
  - main
```
public static void main(String[] args)
```
  - decompressGZIPFile
```
public static Path decompressGZIPFile(Path gzipFile)
```
    Decompresses a gzipped file to a file with the '.gz' extension removed. Does not delete the original file and overwrites any existing file with the same file name as the original with the '.gz' extension removed.
    
    Parameters:
    
    gzipFile - Path to the original gzipped file
    
    Returns:
    
    Path to the decompressed file (same as FileTools.getDecompressedGZIPFileName(Path)) or null if the provided file is not a gzipped file.
  - compressFileUsingGZIP
```
public static Path compressFileUsingGZIP(Path uncompressedFile)
```
    Compresses the provided file using GZIP (adds '.gz' extension)
    
    Parameters:
    
    uncompressedFile - The path to the uncompressed file
    
    Returns:
    
    The path to the compressed file which has a '.gz' extension
  - getDecompressedGZIPFileName
```
public static Path getDecompressedGZIPFileName(Path gzipFile)
```
    Gets a Path to the corresponding uncompressed name of the provided path. If the path does not have a '.gz' extension, it returns the provided path.
    
    Parameters:
    
    gzipFile - The path to the gzipped file.
    
    Returns:
    
    The path to the corresponding uncompressed file if the provided path is a gzipped file. If the provided path doesn't have the '.gz' extension, it returns the provided path.
  - replaceDir
```
public static Path replaceDir(Path path,
                              Path newDir)
```

Class FileTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

RAPIDWRIGHT_VARIABLE_NAME

DEVICE_FILE_SUFFIX

DEVICE_CACHE_FILE_SUFFIX

DATA_FOLDER_NAME

TCL_FOLDER_NAME

JARS_FOLDER_NAME

IMAGES_FOLDER_NAME

PYTHON_FOLDER_NAME

DEVICE_FOLDER_NAME

UNISIM_DATA_FILE_NAME

PART_DUMP_FILE_NAME

PART_DB_PATH

CELL_PIN_DEFAULTS_FILE_NAME

ROUTETHRU_FOLDER_NAME

UNPACK_FOLDERS

emptyIntArray

emptyShortArray

emptyStringArray

PART_DB_FILE_VERSION

UNISIM_DATA_FILE_VERSION

RAPIDWRIGHT_DATA_URL

MD5_DATA_FILE_SUFFIX

BINARY_CHECK_LENGTH

GZIP_START_BYTES

Constructor Detail

FileTools

Method Detail

getKryoZstdOutputStream

getKryoZstdOutputStream

getZstdOutputStream

getZstdOutputStream

getKryoGzipOutputStream

getKryoGzipOutputStream

getKryoOutputStreamWithoutDeflater

getKryoZstdInputStream

getKryoZstdInputStream

getZstdInputStream

getKryoGzipInputStream

getKryoGzipInputStream

getKryoInputStreamWithoutInflater

getAutoBufferedInputStream

useUnsafeStreams

getJavaVersion

getProperInputStream

getProperOutputStream

readHashMap

writeHashMap

writeStringArray

readStringArray

writeIntArray

writeShortArray

readIntArray

readShortArray

writeString

readString

loadFromFile

saveToFile

writeLinesToTextFile

writeStringToTextFile

getLinesFromTextFile

getLastNLinesFromTextFile

getLinesFromInputStream

removeFileExtension

makeDir

makeDirs

getFileSize

deleteFile

deleteFolderContents

deleteFolder

renameFile

copyFile

copyFolder

copyFolderContents

errorIfFileDoesNotExist