JavaFile (root 0.2-SNAPSHOT API)

java.lang.Object
- xyz.cofe.fs.AbstractFile
- - xyz.cofe.fs.java.JavaFile

All Implemented Interfaces:

Comparable<Path>, File, FileAppendBytes, FileAppendText, FileReadBytes, FileReadText, FileWriteBytes, FileWriteText, Path

Direct Known Subclasses:

RootJavaFile
```
public class JavaFile
extends AbstractFile
implements File
```
Файл с стандартной реализацией JAVA

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields
Modifier and Type Field and Description

protected File file

Fields
Modifier and Type	Field and Description
`protected File`	`file`

Constructor Summary

Constructors
Modifier Constructor and Description

protected JavaFile()

JavaFile(File path)

JavaFile(JavaFile src)

JavaFile(String path)

Constructors
Modifier	Constructor and Description
`protected`	`JavaFile()`
	`JavaFile(File path)`
	`JavaFile(JavaFile src)`
	`JavaFile(String path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JavaFile`	`clone()` Создание клона объекта
`int`	`compareTo(Path o)`
`void`	`delete()` Удаляет файл/каталог с содержимым
`void`	`delete(Reciver<File> deleted)` Удаляет файл/каталог с содержимым
`void`	`delete(Reciver<File> deleted, VisitOptions opts)` Удаляет файл/каталог с содержимым
`boolean`	`equals(Object obj)`
`JavaFile`	`getAbsolute()` Возвращает абсолютный путь
`JavaFile`	`getCanonical()` Возвращает каноническую форму
`JavaFile`	`getChild(String name)` Возвращает дочерний путь файла / каталога
`String[]`	`getComponents()` Возвращает компоненты пути
`File`	`getFile()`
`FileSystem`	`getFileSystem()` Возвращает ссылку на файловую систему
`long`	`getLength()` Возвращает длину файла
`Date`	`getModifyDate()` Возвращает дату модификации файла
`String`	`getName()` Возвращает имя файла/каталога, т.е. обычно последний компонент пути
`JavaFile`	`getParent()` Возвращает путь соответствующий предку файла/каталога
`String`	`getPath()` Возвращает весь путь
`int`	`hashCode()`
`boolean`	`isAbsolute()` Проверяет, путь является абсолютным или относительным
`boolean`	`isDirectory()` Возвращает true если файл является каталогом
`boolean`	`isExecutable()` Проверяет права исполнения
`boolean`	`isExists()` Возвращает true если файл существует
`boolean`	`isFile()` Возвращает true если файл является обычным файлом
`protected boolean`	`isOS_Windows()`
`boolean`	`isReadable()` Проверяет возможно ли читать файл
`boolean`	`isRoot()` Проверят что путь является корневым
`boolean`	`isWritable()` Проверяет права записи
`List<File>`	`listFiles()` Возвращает список дочерних файлов
`void`	`mkdir()` Создает каталог
`void`	`mkdirs()` Создает каталог и недостающие родит. каталоги
`BufferedOutputStream`	`openAppend()` Открывает для дозаписи в конец файла
`BufferedInputStream`	`openRead()` Открывает файл для чтения
`RandomAccessFile`	`openReadWrite(OpenMode mode)` Открытие файла для чтения/запичи
`BufferedOutputStream`	`openWrite()` Открывает файл для записи
`void`	`renameTo(File file)` Переименовывает файл/каталог
`void`	`setExecutable(boolean executable)` Устанавливает права исполнения
`void`	`setExecutable(boolean executable, boolean ownerOnly)` Устанавливает права исполнения
`void`	`setModifyDate(Date modifyDate)` Устанавливает дату модификации файла
`void`	`setReadable(boolean readable)` Устанавливает права чтения
`void`	`setReadable(boolean readable, boolean ownerOnly)` Устанавливает права чтения
`void`	`setWritable(boolean writable)` Устанавливает права записи
`void`	`setWritable(boolean writable, boolean ownerOnly)` Устанавливает права записи
`String`	`toString()`
`Iterable<File>`	`walk()` Возвращает последовательность файлов/каталогов для обхода содержимого
`Iterable<File>`	`walk(VisitOptions opts)` Возвращает последовательность файлов/каталогов для обхода содержимого

Methods inherited from class xyz.cofe.fs.AbstractFile
appendBytes, appendBytes, appendBytes, appendText, appendText, getFileHelper, readBytes, readBytes, readBytes, readText, readText, readText, writeBytes, writeBytes, writeBytes, writeText, writeText

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xyz.cofe.fs.FileReadBytes
readBytes, readBytes, readBytes

Methods inherited from interface xyz.cofe.fs.FileReadText
readText, readText, readText

Methods inherited from interface xyz.cofe.fs.FileWriteBytes
writeBytes, writeBytes, writeBytes

Methods inherited from interface xyz.cofe.fs.FileWriteText
writeText, writeText

Methods inherited from interface xyz.cofe.fs.FileAppendBytes
appendBytes, appendBytes, appendBytes

Methods inherited from interface xyz.cofe.fs.FileAppendText
appendText, appendText

- Field Detail
  - file
```
protected File file
```
- Constructor Detail
  - JavaFile
```
protected JavaFile()
```
  - JavaFile
```
public JavaFile(String path)
```
  - JavaFile
```
public JavaFile(File path)
```
  - JavaFile
```
public JavaFile(JavaFile src)
```
- Method Detail
  - clone
```
public JavaFile clone()
```
    Description copied from class: AbstractFile
    
    Создание клона объекта
    
    Specified by:
    
    clone in interface File
    
    Specified by:
    
    clone in class AbstractFile
    
    Returns:
    
    клон
  - getFile
```
public File getFile()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFileSystem
```
public FileSystem getFileSystem()
```
    Description copied from interface: File
    
    Возвращает ссылку на файловую систему
    
    Specified by:
    
    getFileSystem in interface File
    
    Returns:
    
    ссылка на файловую систему
  - getCanonical
```
public JavaFile getCanonical()
```
    Description copied from interface: File
    
    Возвращает каноническую форму
    
    Specified by:
    
    getCanonical in interface File
    
    Specified by:
    
    getCanonical in interface Path
    
    Returns:
    
    Каноническая форма
  - getAbsolute
```
public JavaFile getAbsolute()
```
    Description copied from interface: File
    
    Возвращает абсолютный путь
    
    Specified by:
    
    getAbsolute in interface File
    
    Specified by:
    
    getAbsolute in interface Path
    
    Returns:
    
    Абсолютный путь
  - isAbsolute
```
public boolean isAbsolute()
```
    Description copied from interface: Path
    
    Проверяет, путь является абсолютным или относительным
    
    Specified by:
    
    isAbsolute in interface Path
    
    Returns:
    
    true - Абсолютный
  - isRoot
```
public boolean isRoot()
```
    Description copied from interface: Path
    
    Проверят что путь является корневым
    
    Specified by:
    
    isRoot in interface Path
    
    Returns:
    
    true - корень
  - getParent
```
public JavaFile getParent()
```
    Description copied from interface: File
    
    Возвращает путь соответствующий предку файла/каталога
    
    Specified by:
    
    getParent in interface File
    
    Specified by:
    
    getParent in interface Path
    
    Returns:
    
    Предок или null
  - getChild
```
public JavaFile getChild(String name)
```
    Description copied from interface: File
    
    Возвращает дочерний путь файла / каталога
    
    Specified by:
    
    getChild in interface File
    
    Specified by:
    
    getChild in interface Path
    
    Parameters:
    
    name - Имя файла/каталога
    
    Returns:
    
    Дочерний элемент
  - isDirectory
```
public boolean isDirectory()
```
    Description copied from interface: File
    
    Возвращает true если файл является каталогом
    
    Specified by:
    
    isDirectory in interface File
    
    Returns:
    
    true - каталог
  - isFile
```
public boolean isFile()
```
    Description copied from interface: File
    
    Возвращает true если файл является обычным файлом
    
    Specified by:
    
    isFile in interface File
    
    Returns:
    
    true - файл
  - isExists
```
public boolean isExists()
```
    Description copied from interface: File
    
    Возвращает true если файл существует
    
    Specified by:
    
    isExists in interface File
    
    Returns:
    
    true - существует
  - listFiles
```
public List<File> listFiles()
```
    Description copied from interface: File
    
    Возвращает список дочерних файлов
    
    Specified by:
    
    listFiles in interface File
    
    Returns:
    
    дочерние файлы
  - getModifyDate
```
public Date getModifyDate()
```
    Description copied from interface: File
    
    Возвращает дату модификации файла
    
    Specified by:
    
    getModifyDate in interface File
    
    Returns:
    
    дата модификации файла
  - getLength
```
public long getLength()
```
    Description copied from interface: File
    
    Возвращает длину файла
    
    Specified by:
    
    getLength in interface File
    
    Returns:
    
    длина файла
  - isOS_Windows
```
protected boolean isOS_Windows()
```
  - getComponents
```
public String[] getComponents()
```
    Description copied from interface: Path
    
    Возвращает компоненты пути
    
    Specified by:
    
    getComponents in interface Path
    
    Returns:
    
    компоненты пути
  - getName
```
public String getName()
```
    Description copied from interface: Path
    
    Возвращает имя файла/каталога, т.е. обычно последний компонент пути
    
    Specified by:
    
    getName in interface Path
    
    Returns:
    
    имя файла/каталога
  - getPath
```
public String getPath()
```
    Description copied from interface: Path
    
    Возвращает весь путь
    
    Specified by:
    
    getPath in interface Path
    
    Returns:
    
    путь
  - compareTo
```
public int compareTo(Path o)
```
    Specified by:
    
    compareTo in interface Comparable<Path>
  - openRead
```
public BufferedInputStream openRead()
```
    Description copied from interface: File
    
    Открывает файл для чтения
    
    Specified by:
    
    openRead in interface File
    
    Returns:
    
    Поток байтов для чтения
  - openWrite
```
public BufferedOutputStream openWrite()
```
    Description copied from interface: File
    
    Открывает файл для записи
    
    Specified by:
    
    openWrite in interface File
    
    Returns:
    
    Поток для записи
  - openAppend
```
public BufferedOutputStream openAppend()
```
    Description copied from interface: File
    
    Открывает для дозаписи в конец файла
    
    Specified by:
    
    openAppend in interface File
    
    Returns:
    
    Поток для записи
  - openReadWrite
```
public RandomAccessFile openReadWrite(OpenMode mode)
```
    Description copied from interface: File
    
    Открытие файла для чтения/запичи
    
    Specified by:
    
    openReadWrite in interface File
    
    Parameters:
    
    mode - Режим открытия
    
    Returns:
    
    Случайный доступ к файлу
  - walk
```
public Iterable<File> walk(VisitOptions opts)
```
    Description copied from interface: File
    
    Возвращает последовательность файлов/каталогов для обхода содержимого
    
    Specified by:
    
    walk in interface File
    
    Parameters:
    
    opts - Опции обхода каталога
    
    Returns:
    
    последовательность файлов/каталогов
  - walk
```
public Iterable<File> walk()
```
    Description copied from interface: File
    
    Возвращает последовательность файлов/каталогов для обхода содержимого
    
    Specified by:
    
    walk in interface File
    
    Returns:
    
    последовательность файлов/каталогов
  - isReadable
```
public boolean isReadable()
```
    Description copied from interface: File
    
    Проверяет возможно ли читать файл
    
    Specified by:
    
    isReadable in interface File
    
    Returns:
    
    true - чтение разрешено
  - setReadable
```
public void setReadable(boolean readable)
```
    Description copied from interface: File
    
    Устанавливает права чтения
    
    Specified by:
    
    setReadable in interface File
    
    Parameters:
    
    readable - true - чтение доступно
  - setReadable
```
public void setReadable(boolean readable,
                        boolean ownerOnly)
```
    Description copied from interface: File
    
    Устанавливает права чтения
    
    Specified by:
    
    setReadable in interface File
    
    Parameters:
    
    readable - true - чтение доступно
    
    ownerOnly - true - только для владельца
  - isWritable
```
public boolean isWritable()
```
    Description copied from interface: File
    
    Проверяет права записи
    
    Specified by:
    
    isWritable in interface File
    
    Returns:
    
    true - запись разрешена
  - setWritable
```
public void setWritable(boolean writable)
```
    Description copied from interface: File
    
    Устанавливает права записи
    
    Specified by:
    
    setWritable in interface File
    
    Parameters:
    
    writable - true - запись разрешена
  - setWritable
```
public void setWritable(boolean writable,
                        boolean ownerOnly)
```
    Description copied from interface: File
    
    Устанавливает права записи
    
    Specified by:
    
    setWritable in interface File
    
    Parameters:
    
    writable - true - запись разрешена
    
    ownerOnly - true - только для владельца
  - isExecutable
```
public boolean isExecutable()
```
    Description copied from interface: File
    
    Проверяет права исполнения
    
    Specified by:
    
    isExecutable in interface File
    
    Returns:
    
    true - исполнение разрешено
  - setExecutable
```
public void setExecutable(boolean executable)
```
    Description copied from interface: File
    
    Устанавливает права исполнения
    
    Specified by:
    
    setExecutable in interface File
    
    Parameters:
    
    executable - true - исполнение разрешено
  - setExecutable
```
public void setExecutable(boolean executable,
                          boolean ownerOnly)
```
    Description copied from interface: File
    
    Устанавливает права исполнения
    
    Specified by:
    
    setExecutable in interface File
    
    Parameters:
    
    executable - true - исполнение разрешено
    
    ownerOnly - true - только для владельца
  - setModifyDate
```
public void setModifyDate(Date modifyDate)
```
    Description copied from interface: File
    
    Устанавливает дату модификации файла
    
    Specified by:
    
    setModifyDate in interface File
    
    Parameters:
    
    modifyDate - дата модификации файла
  - delete
```
public void delete()
```
    Description copied from interface: File
    
    Удаляет файл/каталог с содержимым
    
    Specified by:
    
    delete in interface File
  - delete
```
public void delete(Reciver<File> deleted)
```
    Description copied from interface: File
    
    Удаляет файл/каталог с содержимым
    
    Specified by:
    
    delete in interface File
    
    Parameters:
    
    deleted - удаленные файлы/каталоги
  - delete
```
public void delete(Reciver<File> deleted,
                   VisitOptions opts)
```
    Description copied from interface: File
    
    Удаляет файл/каталог с содержимым
    
    Specified by:
    
    delete in interface File
    
    Parameters:
    
    deleted - удаленные файлы/каталоги
    
    opts - опции обхода каталога
  - mkdir
```
public void mkdir()
```
    Description copied from interface: File
    
    Создает каталог
    
    Specified by:
    
    mkdir in interface File
  - mkdirs
```
public void mkdirs()
```
    Description copied from interface: File
    
    Создает каталог и недостающие родит. каталоги
    
    Specified by:
    
    mkdirs in interface File
  - renameTo
```
public void renameTo(File file)
```
    Description copied from interface: File
    
    Переименовывает файл/каталог
    
    Specified by:
    
    renameTo in interface File
    
    Parameters:
    
    file - новое имя
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JavaFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xyz.cofe.fs.AbstractFile

Methods inherited from class java.lang.Object

Methods inherited from interface xyz.cofe.fs.FileReadBytes

Methods inherited from interface xyz.cofe.fs.FileReadText

Methods inherited from interface xyz.cofe.fs.FileWriteBytes

Methods inherited from interface xyz.cofe.fs.FileWriteText

Methods inherited from interface xyz.cofe.fs.FileAppendBytes

Methods inherited from interface xyz.cofe.fs.FileAppendText

Field Detail

file

Constructor Detail

JavaFile

JavaFile

JavaFile

JavaFile

Method Detail

clone

getFile

equals

hashCode

getFileSystem

getCanonical

getAbsolute

isAbsolute

isRoot

getParent

getChild

isDirectory

isFile

isExists

listFiles

getModifyDate

getLength

isOS_Windows

getComponents

getName

getPath

compareTo

openRead

openWrite

openAppend

openReadWrite

walk

walk

isReadable

setReadable

setReadable

isWritable

setWritable

setWritable

isExecutable

setExecutable

setExecutable

setModifyDate

delete

delete

delete

mkdir

mkdirs

renameTo

toString