Class AbsoluteFile

java.lang.Object

de.tomatengames.util.io.AbsoluteFile

public class AbsoluteFile
extends Object

An AbsoluteFile represents an absolute and direct path to a file. It is meant to be used with Files. See AbsolutePath for usage with Paths.

Since:

1.6

Method Summary

Modifier and Type	Method	Description
boolean	contains(AbsoluteFile file)	contains(AbsoluteFile, boolean) with allowSame=false.
boolean	contains(AbsoluteFile file, boolean allowSame)	Returns whether the specified file is inside this file.
static AbsoluteFile	get(File file)	Returns an AbsoluteFile that represents the File.getCanonicalPath() of the specified file.
static AbsoluteFile	get(String file)	Returns an AbsoluteFile that represents the File.getCanonicalPath() of the specified file.
File	getFile()	Returns a File that represents this file.
String	getPath()	Returns the absolute and direct path that represents this file.
AbsoluteFile	resolveInside(String subpath)	Returns the file inside this file resolved from the specified subpath.
AbsoluteFile	resolveInside(String subpath, boolean allowSame)	Returns the file inside this file resolved from the specified subpath.
String	toString()

Methods inherited from class Object

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

Method Details

get

public static AbsoluteFile get(String file)
                        throws IOException

Returns an AbsoluteFile that represents the File.getCanonicalPath() of the specified file.

Parameters:

file - the filename

Returns:

the AbsoluteFile of the specified file

Throws:

IOException - if an IOException occurs from File.getCanonicalPath()

get

public static AbsoluteFile get(File file)
                        throws IOException

Returns an AbsoluteFile that represents the File.getCanonicalPath() of the specified file.

Parameters:

file - the file

Returns:

the AbsoluteFile of the specified file

Throws:

IOException - if an IOException occurs from File.getCanonicalPath()

getPath

public String getPath()

Returns the absolute and direct path that represents this file.

Returns:

the absolute and direct path that represents this file

getFile

public File getFile()

Returns a File that represents this file.

Returns:

a File that represents this file

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(AbsoluteFile file)

contains(AbsoluteFile, boolean) with allowSame=false.

Parameters:

file - the file

Returns:

whether the specified file is inside this file

contains

public boolean contains(AbsoluteFile file,
 boolean allowSame)

Returns whether the specified file is inside this file.

Parameters:

file - the file

allowSame - whether to return true if the specified file equals this file

Returns:

whether the specified file is inside this file.

resolveInside

public AbsoluteFile resolveInside(String subpath)
                           throws IOException

Returns the file inside this file resolved from the specified subpath.

Parameters:

subpath - the subpath to resolve

Returns:

the resolved file

Throws:

FileNotFoundException - if the resolved file is not inside this file

IOException

See Also:

• contains(AbsoluteFile)

resolveInside

public AbsoluteFile resolveInside(String subpath,
 boolean allowSame)
                           throws IOException

Returns the file inside this file resolved from the specified subpath.

Parameters:

subpath - the subpath to resolve

allowSame - whether to accept the resolved file if it equals this file

Returns:

the resolved file

Throws:

FileNotFoundException - if the resolved file is not inside this file

IOException

See Also:

• contains(AbsoluteFile, boolean)