com.android.builder.files

Class RelativeFile

java.lang.Object

com.android.builder.files.RelativeFile

public class RelativeFile
extends java.lang.Object

Representation of a file with respect to a base directory. A RelativeFile contains information on the file, the base directory and the relative path from the base directory to the file. The relative path is kept in OS independent form with sub directories separated by slashes.

Neither the file nor the base need to exist. They are treated as abstract paths.

Constructor Summary

Constructors

Constructor and Description
RelativeFile(java.io.File base, java.io.File file) Creates a new relative file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.io.File	getBase() Obtains the base directory.
java.io.File	getFile() Obtains the file.
java.lang.String	getOsIndependentRelativePath() Obtains the OS independent path.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelativeFile

public RelativeFile(@NonNull
                    java.io.File base,
                    @NonNull
                    java.io.File file)

Creates a new relative file.

Parameters:

base - the base directory

file - the file, must not be the same as the base directory and must be located inside base

Method Detail

getBase

@NonNull
public java.io.File getBase()

Obtains the base directory.

Returns:

the base directory as provided when created the object

getFile

@NonNull
public java.io.File getFile()

Obtains the file.

Returns:

the file as provided when created the object

getOsIndependentRelativePath

@NonNull
public java.lang.String getOsIndependentRelativePath()

Obtains the OS independent path. The general contract of the normalized relative path is that by replacing the slashes by file separators in the relative path and appending it to the base directory's path, the resulting path is the file's path

Returns:

the normalized path, separated by slashes; directories have a terminating slash

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object