co.codewizards.cloudstore.core.oio

Class IoFile

java.lang.Object

co.codewizards.cloudstore.core.oio.IoFile

All Implemented Interfaces:

File, Serializable

Direct Known Subclasses:

NioFile

public class IoFile
extends Object
implements File

Author:

Sebastian Schefczyk

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected File	ioFile

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IoFile(File ioFile)
protected	IoFile(File parent, String child)
protected	IoFile(String pathname)
protected	IoFile(String parent, String child)
protected	IoFile(URI uri)

Method Summary

Modifier and Type	Method and Description
boolean	canExecute()
boolean	canRead()
boolean	canWrite()
int	compareTo(File otherFile)
void	copyToCopyAttributes(File toFile) Copies a file, a symlink (depends on environment/implementation) or a directory (non-recursive).
File	createFile(String... children) Create a child-File.
IInputStream	createInputStream()
boolean	createNewFile()
IOutputStream	createOutputStream()
IOutputStream	createOutputStream(boolean append)
RandomAccessFile	createRandomAccessFile(String mode)
void	createSymbolicLink(String targetPath)
boolean	delete()
void	deleteOnExit()
void	deleteRecursively()
boolean	equals(Object obj)
boolean	exists()
boolean	existsNoFollow()
File	getAbsoluteFile()
String	getAbsolutePath()
File	getCanonicalFile()
String	getCanonicalPath()
long	getFreeSpace()
File	getIoFile() Caution: Only use this when forced by 3rd party interface!
long	getLastModifiedNoFollow()
String	getName()
File	getParentFile()
String	getPath()
long	getUsableSpace()
int	hashCode()
boolean	isAbsolute()
boolean	isDirectory()
boolean	isDirectoryFollowSymLinks()
boolean	isDirectoryNoFollowSymLinks()
boolean	isFile()
boolean	isRegularFileFollowLinks()
boolean	isRegularFileNoFollowLinks()
boolean	isSymbolicLink()
long	lastModified()
long	length()
String[]	list()
String[]	list(FilenameFilter filenameFilter)
File[]	listFiles()
File[]	listFiles(FileFilter fileFilter)
File[]	listFiles(FileFilter fileFilter)
File[]	listFiles(FilenameFilter fileFilter)
boolean	mkdir()
boolean	mkdirs()
void	move(File toFile) This is platform independent, in contrast to File.renameTo(File) respectively File.renameTo(java.io.File).
String	readSymbolicLinkToPathString() Convenience method for the often called chain: java.io.File --> java.nio.Path --> Files.readSymbolicLink --> IOUtil.toPathString Without symlinks, this method would not be needed.
String	relativize(File target)
boolean	renameTo(File dest) This is platform dependent (e.g.
boolean	setExecutable(boolean executable)
boolean	setExecutable(boolean executable, boolean ownerOnly)
boolean	setLastModified(long lastModified)
boolean	setLastModifiedNoFollow(long lastModified)
boolean	setReadable(boolean readable)
boolean	setReadable(boolean readable, boolean ownerOnly)
boolean	setWritable(boolean writable)
boolean	setWritable(boolean writable, boolean ownerOnly)
String	toString()
URI	toURI()

Methods inherited from class java.lang.Object

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

Field Detail

ioFile

protected final File ioFile

Constructor Detail

IoFile

protected IoFile(String pathname)

IoFile

protected IoFile(File parent,
                 String child)

IoFile

protected IoFile(String parent,
                 String child)

IoFile

protected IoFile(URI uri)

IoFile

protected IoFile(File ioFile)

Method Detail

getParentFile

public File getParentFile()

Specified by:

getParentFile in interface File

list

public String[] list()

Specified by:

list in interface File

list

public String[] list(FilenameFilter filenameFilter)

Specified by:

list in interface File

listFiles

public File[] listFiles()

Specified by:

listFiles in interface File

listFiles

public File[] listFiles(FileFilter fileFilter)

Specified by:

listFiles in interface File

listFiles

public File[] listFiles(FileFilter fileFilter)

Specified by:

listFiles in interface File

listFiles

public File[] listFiles(FilenameFilter fileFilter)

Specified by:

listFiles in interface File

getAbsoluteFile

public File getAbsoluteFile()

Specified by:

getAbsoluteFile in interface File

exists

public boolean exists()

Specified by:

exists in interface File

existsNoFollow

public boolean existsNoFollow()

Specified by:

existsNoFollow in interface File

createNewFile

public boolean createNewFile()
                      throws IOException

Specified by:

createNewFile in interface File

Throws:

IOException

canExecute

public boolean canExecute()

Specified by:

canExecute in interface File

canRead

public boolean canRead()

Specified by:

canRead in interface File

canWrite

public boolean canWrite()

Specified by:

canWrite in interface File

setExecutable

public boolean setExecutable(boolean executable)

Specified by:

setExecutable in interface File

setExecutable

public boolean setExecutable(boolean executable,
                             boolean ownerOnly)

Specified by:

setExecutable in interface File

setReadable

public boolean setReadable(boolean readable)

Specified by:

setReadable in interface File

setReadable

public boolean setReadable(boolean readable,
                           boolean ownerOnly)

Specified by:

setReadable in interface File

setWritable

public boolean setWritable(boolean writable)

Specified by:

setWritable in interface File

setWritable

public boolean setWritable(boolean writable,
                           boolean ownerOnly)

Specified by:

setWritable in interface File

compareTo

public int compareTo(File otherFile)

Specified by:

compareTo in interface File

delete

public boolean delete()

Specified by:

delete in interface File

deleteOnExit

public void deleteOnExit()

Specified by:

deleteOnExit in interface File

deleteRecursively

public void deleteRecursively()

Specified by:

deleteRecursively in interface File

getAbsolutePath

public String getAbsolutePath()

Specified by:

getAbsolutePath in interface File

getCanonicalFile

public File getCanonicalFile()
                      throws IOException

Specified by:

getCanonicalFile in interface File

Throws:

IOException

getCanonicalPath

public String getCanonicalPath()
                        throws IOException

Specified by:

getCanonicalPath in interface File

Throws:

IOException

getFreeSpace

public long getFreeSpace()

Specified by:

getFreeSpace in interface File

length

public long length()

Specified by:

length in interface File

isRegularFileNoFollowLinks

public boolean isRegularFileNoFollowLinks()

Specified by:

isRegularFileNoFollowLinks in interface File

isRegularFileFollowLinks

public boolean isRegularFileFollowLinks()

Specified by:

isRegularFileFollowLinks in interface File

isDirectoryNoFollowSymLinks

public boolean isDirectoryNoFollowSymLinks()

Specified by:

isDirectoryNoFollowSymLinks in interface File

isDirectoryFollowSymLinks

public boolean isDirectoryFollowSymLinks()

Specified by:

isDirectoryFollowSymLinks in interface File

isSymbolicLink

public boolean isSymbolicLink()

Specified by:

isSymbolicLink in interface File

readSymbolicLinkToPathString

public String readSymbolicLinkToPathString()
                                    throws IOException

Description copied from interface: File

Convenience method for the often called chain:

java.io.File --> java.nio.Path --> Files.readSymbolicLink --> IOUtil.toPathString

Without symlinks, this method would not be needed.

Specified by:

readSymbolicLinkToPathString in interface File

Throws:

IOException

getLastModifiedNoFollow

public long getLastModifiedNoFollow()

Specified by:

getLastModifiedNoFollow in interface File

renameTo

public boolean renameTo(File dest)

Description copied from interface: File

This is platform dependent (e.g. might fail at renaming between different partitions). Plz see File.renameTo(java.io.File).

Specified by:

renameTo in interface File

setLastModified

public boolean setLastModified(long lastModified)

Specified by:

setLastModified in interface File

createOutputStream

public IOutputStream createOutputStream()
                                 throws FileNotFoundException

Specified by:

createOutputStream in interface File

Throws:

FileNotFoundException

createInputStream

public IInputStream createInputStream()
                               throws FileNotFoundException

Specified by:

createInputStream in interface File

Throws:

FileNotFoundException

createOutputStream

public IOutputStream createOutputStream(boolean append)
                                 throws FileNotFoundException

Specified by:

createOutputStream in interface File

Throws:

FileNotFoundException

getName

public String getName()

Specified by:

getName in interface File

createSymbolicLink

public void createSymbolicLink(String targetPath)
                        throws IOException

Specified by:

createSymbolicLink in interface File

Throws:

IOException

lastModified

public long lastModified()

Specified by:

lastModified in interface File

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface File

getPath

public String getPath()

Specified by:

getPath in interface File

mkdir

public boolean mkdir()

Specified by:

mkdir in interface File

mkdirs

public boolean mkdirs()

Specified by:

mkdirs in interface File

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface File

move

public void move(File toFile)
          throws IOException

Description copied from interface: File

This is platform independent, in contrast to File.renameTo(File) respectively File.renameTo(java.io.File).

Specified by:

move in interface File

Throws:

IOException

copyToCopyAttributes

public void copyToCopyAttributes(File toFile)
                          throws IOException

Description copied from interface: File

Copies a file, a symlink (depends on environment/implementation) or a directory (non-recursive).

Specified by:

copyToCopyAttributes in interface File

Throws:

IOException

createRandomAccessFile

public RandomAccessFile createRandomAccessFile(String mode)
                                        throws FileNotFoundException

Specified by:

createRandomAccessFile in interface File

Throws:

FileNotFoundException

toURI

public URI toURI()

Specified by:

toURI in interface File

isFile

public boolean isFile()

Specified by:

isFile in interface File

setLastModifiedNoFollow

public boolean setLastModifiedNoFollow(long lastModified)

Specified by:

setLastModifiedNoFollow in interface File

relativize

public String relativize(File target)
                  throws IOException

Specified by:

relativize in interface File

Throws:

IOException

getUsableSpace

public long getUsableSpace()

Specified by:

getUsableSpace in interface File

getIoFile

public File getIoFile()

Description copied from interface: File

Caution: Only use this when forced by 3rd party interface!

Specified by:

getIoFile in interface File

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createFile

public File createFile(String... children)

Description copied from interface: File

Create a child-File.

This method appends sub-path-elements. It is synonymous to createFile(thisFile, children) and more intuitive.

Specified by:

createFile in interface File

Parameters:

children - the children to be appended. May be null or empty.

Returns:

the new File. Never null.