co.codewizards.cloudstore.core.oio

Interface File

All Superinterfaces:

Serializable

All Known Implementing Classes:

IoFile, NioFile

public interface File
extends Serializable

Substitute for java.io.File. Also there are many methods as known from java.nio.file.Files and java.nio.file.Paths.

Author:

Sebastian Schefczyk

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	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()
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 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 newFileName) This is platform dependent (e.g.
boolean	setExecutable(boolean executable)
boolean	setExecutable(boolean executable, boolean ownerOnly)
boolean	setLastModified(long lastModified)
boolean	setLastModifiedNoFollow(long time)
boolean	setReadable(boolean readable)
boolean	setReadable(boolean readable, boolean ownerOnly)
boolean	setWritable(boolean writable)
boolean	setWritable(boolean writable, boolean ownerOnly)
URI	toURI()

Method Detail

list

String[] list()

list

String[] list(FilenameFilter filenameFilter)

listFiles

File[] listFiles()

listFiles

File[] listFiles(FileFilter fileFilter)

listFiles

File[] listFiles(FileFilter fileFilter)

listFiles

File[] listFiles(FilenameFilter fileFilter)

createFile

File createFile(String... children)

Create a child-File.

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

Parameters:

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

Returns:

the new File. Never null.

getAbsoluteFile

File getAbsoluteFile()

getParentFile

File getParentFile()

isSymbolicLink

boolean isSymbolicLink()

canWrite

boolean canWrite()

canRead

boolean canRead()

canExecute

boolean canExecute()

setExecutable

boolean setExecutable(boolean executable)

setReadable

boolean setReadable(boolean readable)

setReadable

boolean setReadable(boolean readable,
                    boolean ownerOnly)

setWritable

boolean setWritable(boolean writable)

setWritable

boolean setWritable(boolean writable,
                    boolean ownerOnly)

readSymbolicLinkToPathString

String readSymbolicLinkToPathString()
                             throws IOException

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.

Throws:

IOException

exists

boolean exists()

existsNoFollow

boolean existsNoFollow()

createNewFile

boolean createNewFile()
               throws IOException

Throws:

IOException

compareTo

int compareTo(File otherFile)

delete

boolean delete()

deleteOnExit

void deleteOnExit()

deleteRecursively

void deleteRecursively()

getFreeSpace

long getFreeSpace()

getCanonicalPath

String getCanonicalPath()
                 throws IOException

Throws:

IOException

getCanonicalFile

File getCanonicalFile()
               throws IOException

Throws:

IOException

getAbsolutePath

String getAbsolutePath()

isRegularFileFollowLinks

boolean isRegularFileFollowLinks()

isRegularFileNoFollowLinks

boolean isRegularFileNoFollowLinks()

mkdir

boolean mkdir()

isDirectory

boolean isDirectory()

isDirectoryNoFollowSymLinks

boolean isDirectoryNoFollowSymLinks()

isDirectoryFollowSymLinks

boolean isDirectoryFollowSymLinks()

getUsableSpace

long getUsableSpace()

length

long length()

renameTo

boolean renameTo(File newFileName)

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

setLastModified

boolean setLastModified(long lastModified)

createOutputStream

IOutputStream createOutputStream()
                          throws FileNotFoundException

Throws:

FileNotFoundException

createOutputStream

IOutputStream createOutputStream(boolean append)
                          throws FileNotFoundException

Throws:

FileNotFoundException

createInputStream

IInputStream createInputStream()
                        throws FileNotFoundException

Throws:

FileNotFoundException

getName

String getName()

createSymbolicLink

void createSymbolicLink(String targetPath)
                 throws IOException

Throws:

IOException

lastModified

long lastModified()

getLastModifiedNoFollow

long getLastModifiedNoFollow()

isAbsolute

boolean isAbsolute()

getPath

String getPath()

mkdirs

boolean mkdirs()

copyToCopyAttributes

void copyToCopyAttributes(File toFile)
                   throws IOException

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

Throws:

IOException

move

void move(File toFile)
   throws IOException

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

Throws:

IOException

toURI

URI toURI()

createRandomAccessFile

RandomAccessFile createRandomAccessFile(String mode)
                                 throws FileNotFoundException

Throws:

FileNotFoundException

isFile

boolean isFile()

setLastModifiedNoFollow

boolean setLastModifiedNoFollow(long time)

relativize

String relativize(File target)
           throws IOException

Throws:

IOException

setExecutable

boolean setExecutable(boolean executable,
                      boolean ownerOnly)

getIoFile

File getIoFile()

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