com.SIMRacingApps.Util

Class FindFile

java.lang.Object

com.SIMRacingApps.Util.FindFile

public class FindFile
extends java.lang.Object

This class has helper methods for finding and opening files in the user's path or classpath.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors

Constructor and Description
FindFile(java.lang.String pathname) Constructor for finding a file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the InputStream.
static void	copy(FindFile src, java.io.File dest) Copies the src file to the dest file.
static void	copy(java.io.InputStream is, java.io.File src, java.io.File dest)
void	finalize()
static FindFile	find(java.util.ArrayList<java.lang.String> pathnames) Provided an array of names, this returns the first one found.
static java.lang.String	getAppData() Returns the path to the App Data folder, and makes sure it exists.
java.io.InputStream	getBufferedInputStream() Returns the BufferedInputStream of the file.
java.io.File	getFile() Returns the java.io.File object for the file that was found.
java.lang.String	getFileFound() Returns the name of the file that was found including the path to where it was found.
java.io.InputStream	getInputStream() Returns the InputStream of the file.
java.util.Map<java.lang.String,java.lang.Object>	getJSON() Returns the contents of the file parsed as a JSON file as a Map<String,Object> type.
java.net.URL	getURL() Returns a URL to the found file.
static java.lang.String	getUserDocumentsPath() Returns the path to the users Documents location.
static java.lang.String[]	getUserPath() Returns an array of the user's paths.
static void	setUserPath(java.lang.String path) Sets the user's paths by parsing the "path" argument for semicolon as a separator.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FindFile

public FindFile(java.lang.String pathname)
         throws java.io.FileNotFoundException

Constructor for finding a file. It looks in the current directory, then in each directory from the user's path, then the directories in the classpath. If found, it opens an InputStream to the file, so don't forget to close it.

Parameters:

pathname - The path to the file found.

Throws:

java.io.FileNotFoundException - When the file cannot be found.

Method Detail

find

public static FindFile find(java.util.ArrayList<java.lang.String> pathnames)
                     throws java.io.FileNotFoundException

Provided an array of names, this returns the first one found.

Parameters:

pathnames - An array of files to find.

Returns:

The file found.

Throws:

java.io.FileNotFoundException - When none of the files are found.

getFile

public java.io.File getFile()

Returns the java.io.File object for the file that was found. It may not be able to do certain things if the file is found in a jar.

Returns:

The File object.

getUserDocumentsPath

public static java.lang.String getUserDocumentsPath()

Returns the path to the users Documents location.

Returns:

The path to the user's documents location.

getAppData

public static java.lang.String getAppData()

Returns the path to the App Data folder, and makes sure it exists.

Returns:

The path to the App Data folder.

getUserPath

public static java.lang.String[] getUserPath()

Returns an array of the user's paths. If the user has not set their own path, then the users "My Documents" location will be used to create a SIMRacingApps folder.

Returns:

An array of the user's paths.

setUserPath

public static void setUserPath(java.lang.String path)

Sets the user's paths by parsing the "path" argument for semicolon as a separator. If the path is null or empty, it will not change the existing path. If the path is relative, then it will be created in the user's documents folder.

Parameters:

path - A semicolon separated list of directories to use as the user's path.

getFileFound

public java.lang.String getFileFound()

Returns the name of the file that was found including the path to where it was found. If found in the classpath, the original name is returned.

Returns:

Then name of the file found.

getInputStream

public java.io.InputStream getInputStream()

Returns the InputStream of the file.

Returns:

The InputStream or null of not found

getBufferedInputStream

public java.io.InputStream getBufferedInputStream()

Returns the BufferedInputStream of the file.

Returns:

The BufferedInputStream or null of not found

getURL

public java.net.URL getURL()

Returns a URL to the found file.

Returns:

The URL to the file.

copy

public static void copy(FindFile src,
                        java.io.File dest)

Copies the src file to the dest file.

Parameters:

src - The source FindFile instance

dest - The dest filename

copy

public static void copy(java.io.InputStream is,
                        java.io.File src,
                        java.io.File dest)

close

public void close()

Closes the InputStream.

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getJSON

public java.util.Map<java.lang.String,java.lang.Object> getJSON()

Returns the contents of the file parsed as a JSON file as a Map<String,Object> type. To detect a file not found, the map will be empty.

Returns:

The Map<String,Object> instance of the parsed JSON file.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object