repicea.io

Class RelativePathFile

java.lang.Object

java.io.File

repicea.io.RelativePathFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.io.File>

public class RelativePathFile
extends java.io.File
implements java.lang.Cloneable, java.io.Serializable

The RelativePathFile class extends the File class. It also contains a reference directory, which makes it possible to get a relative path from that directory. This class is useful to compare two files from different repositories for example. If the specified directory has nothing to do with the file itself, the relative path is null.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
RelativePathFile(java.io.File file, java.io.File rootPath) Constructor 3.
RelativePathFile(java.lang.String filename, java.io.File rootPath) Constructor 2.
RelativePathFile(java.lang.String filename, java.lang.String rootPathname) Constructor 1.

Method Summary

Modifier and Type	Method and Description
RelativePathFile	clone() This method returns a deep clone of the RelativePathFile.
int	compareTo(java.io.File pathName)
protected java.util.Vector<java.lang.String>	getRelativePartsVector()
java.lang.String	getRelativePath()
protected java.lang.String	getRootPathname()
boolean	include(RelativePathFile file) This method checks if this relative path file has a path that includes the file specified in parameter.
protected void	setRelativeTo(java.lang.String rootPathname)

Methods inherited from class java.io.File

canExecute, canRead, canWrite, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativePathFile

public RelativePathFile(java.lang.String filename,
                        java.lang.String rootPathname)

Constructor 1.

Parameters:

filename - the filename of the file to be relative to the reference directory

rootPathname - the reference directory from which the file is relative

RelativePathFile

public RelativePathFile(java.lang.String filename,
                        java.io.File rootPath)

Constructor 2.

Parameters:

filename - the filename of the file to be relative to the reference directory

rootPath - the reference directory from which the file is relative

RelativePathFile

public RelativePathFile(java.io.File file,
                        java.io.File rootPath)

Constructor 3.

Parameters:

file - the file to be relative to the reference directory

rootPath - the reference directory from which the file is relative

Method Detail

setRelativeTo

protected void setRelativeTo(java.lang.String rootPathname)

getRelativePath

public java.lang.String getRelativePath()

compareTo

public int compareTo(java.io.File pathName)

Specified by:

compareTo in interface java.lang.Comparable<java.io.File>

Overrides:

compareTo in class java.io.File

getRelativePartsVector

protected java.util.Vector<java.lang.String> getRelativePartsVector()

getRootPathname

protected java.lang.String getRootPathname()

include

public boolean include(RelativePathFile file)

This method checks if this relative path file has a path that includes the file specified in parameter. If this file is really a file, the method returns true if the file parameter has the same relative path and name. If this file is a directory, the method returns true if the file parameter is included in the directory or a subdirectory.

Parameters:

file - a RelativePathFile instance

Returns:

a boolean

clone

public RelativePathFile clone()

This method returns a deep clone of the RelativePathFile.

Overrides:

clone in class java.lang.Object