FileVisitor (fs-itf 0.1 API)

java.lang.Object
- xyz.cofe.fs.FileVisitor

```
public class FileVisitor
extends Object
```
Осуществляет обход каталога

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileVisitor.ConvertTreeWalk<T extends File>`
`static class`	`FileVisitor.CopyOptions` Опции копирования
`static class`	`FileVisitor.ErrorBehavior` Поведение при возниконовеии ошибки

Field Summary

Fields
Modifier and Type Field and Description

protected xyz.cofe.collection.Predicate<Stack<File>> filter

Fields
Modifier and Type	Field and Description
`protected xyz.cofe.collection.Predicate<Stack<File>>`	`filter`

Constructor Summary

Constructors
Constructor and Description
`FileVisitor()` Конструктор по умолчанию
`FileVisitor(FileVisitor src, FileVisitor.CopyOptions opts)` Конструктор копирования

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileVisitor`	`clone()` Клонирует объект
`FileVisitor`	`clone(FileVisitor.CopyOptions opts)` Клонирует объект
`void`	`enter(Stack<File> path)` Вызывается при входе в каталог/файл
`FileVisitor.ErrorBehavior`	`error(Throwable err)` Вызывается при возниконовении ошибки
`void`	`exit(Stack<File> path)` Вызывается при выходе из каталога/файла
`FileVisitor.ErrorBehavior`	`getErrorBehavior()` Поведение при возникновении ошибки
`xyz.cofe.collection.Predicate<Stack<File>>`	`getFilter()` Вызывается перед входом в каталог для проверки необходимости войти
`int`	`getMaxRecusiveLinkLevel()` Максимальная глубина вложенности символических ссылок.
`Set<File>`	`getVisitHistory()` Возвращает набор посещенных файлов/каталогов
`boolean`	`isCheckHistory()` Проверять историю посещенных каталог/файлов, что бы избежать бесконечных циклов.
`boolean`	`isFollowLink()` Следовать символическим ссылкам.
`boolean`	`isResolveLink()` "Разрешать" символические ссылки.
`boolean`	`isUseAbsolutePath()` Приводить пути файлов к абсолютной форме, по умолч. false.
`boolean`	`isUseCanonicalPath()` Приводить пути файлов к канонической форме, по умолч. true.
`protected File`	`resolveLink(ResolveLink<File> rl, int currentResolve, int maxResolve)` Рекурсивно разрешает ссылки
`void`	`setCheckHistory(boolean checkHistory)` Проверять историю посещенных каталог/файлов, что бы избежать бесконечных циклов.
`void`	`setErrorBehavior(FileVisitor.ErrorBehavior errorBehavior)` Поведение при возникновении ошибки
`void`	`setFilter(xyz.cofe.collection.Predicate<Stack<File>> filter)` Вызывается перед входом в каталог для проверки необходимости войти
`void`	`setFollowLink(boolean followLink)` Следовать символическим ссылкам.
`void`	`setMaxRecusiveLinkLevel(int maxRecusiveLinkLevel)` Максимальная глубина вложенности символических ссылок.
`void`	`setResolveLink(boolean resolveLink)` "Разрешать" символические ссылки.
`void`	`setUseAbsolutePath(boolean useCanonicalPath)` Приводить пути файлов к абсолютной форме
`void`	`setUseCanonicalPath(boolean useCanonicalPath)` Приводить пути файлов к канонической форме
`Iterable<xyz.cofe.collection.iterators.TreeWalk<File>>`	`treeWalkIterable(File root)`
`void`	`walk(File root)` Осуществляет обход каталога, вызывает методы enter/exit
`Iterable<File>`	`walkIterable(File root)` Возвращает последовательность файлов/каталогов (включая вложенгные)

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

- Field Detail
  - filter
```
protected xyz.cofe.collection.Predicate<Stack<File>> filter
```
- Constructor Detail
  - FileVisitor
```
public FileVisitor()
```
    Конструктор по умолчанию
  - FileVisitor
```
public FileVisitor(FileVisitor src,
                   FileVisitor.CopyOptions opts)
```
    Конструктор копирования
    
    Parameters:
    
    src - образец
    
    opts - Опции копирования
- Method Detail
  - clone
```
public FileVisitor clone()
```
    Клонирует объект
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    копия объекта
  - clone
```
public FileVisitor clone(FileVisitor.CopyOptions opts)
```
    Клонирует объект
    
    Parameters:
    
    opts - Опции копирования
    
    Returns:
    
    копия объекта
  - enter
```
public void enter(Stack<File> path)
```
    Вызывается при входе в каталог/файл
    
    Parameters:
    
    path - Путь/файл в который осуществляется вход
  - exit
```
public void exit(Stack<File> path)
```
    Вызывается при выходе из каталога/файла
    
    Parameters:
    
    path - Путь/файл из которого осуществляется выход
  - error
```
public FileVisitor.ErrorBehavior error(Throwable err)
```
    Вызывается при возниконовении ошибки
    
    Parameters:
    
    err - Ошибка
    
    Returns:
    
    true - продолжить выполнение, false - завершить работу
  - getVisitHistory
```
public Set<File> getVisitHistory()
```
    Возвращает набор посещенных файлов/каталогов
    
    Returns:
    
    Список файлов
  - getErrorBehavior
```
public FileVisitor.ErrorBehavior getErrorBehavior()
```
    Поведение при возникновении ошибки
    
    Returns:
    
    поведение
  - setErrorBehavior
```
public void setErrorBehavior(FileVisitor.ErrorBehavior errorBehavior)
```
    Поведение при возникновении ошибки
    
    Parameters:
    
    errorBehavior - поведение
  - isCheckHistory
```
public boolean isCheckHistory()
```
    Проверять историю посещенных каталог/файлов, что бы избежать бесконечных циклов. По умолчанию true.
    
    Returns:
    
    Проверять историю посещенных каталог/файлов
  - setCheckHistory
```
public void setCheckHistory(boolean checkHistory)
```
    Проверять историю посещенных каталог/файлов, что бы избежать бесконечных циклов.
    
    Parameters:
    
    checkHistory - Проверять историю посещенных каталог/файлов
  - isFollowLink
```
public boolean isFollowLink()
```
    Следовать символическим ссылкам. По умолчанию true.
    Если true - то, с. ссылки будут испоьзоватся в качестве ссылок на каталоги
    
    Returns:
    
    Следовать символическим ссылкам.
  - setFollowLink
```
public void setFollowLink(boolean followLink)
```
    Следовать символическим ссылкам.
    
    Parameters:
    
    followLink - Следовать символическим ссылкам.
  - isResolveLink
```
public boolean isResolveLink()
```
    "Разрешать" символические ссылки. По умолчанию false.
    Если установлено в true - то, при нахождении символической ссылки будет установлено куда она указывает и использовано разрешенное имя.
    
    Пример:
    Есть следующая структура файлов
    
    /A/
    /A/1
    /A/link -> /B
    /B/
    /B/2
    /B/3
    
    resolveLink = false resolveLink = true
    
    /A/
    /A/1
    /A/link/
    /A/link/2
    /A/link/3
    /B/
    /B/2
    /B/3
    /A/
    /A/1
    /B/
    /B/2
    /B/3
    
    Returns:
    
    "Разрешать" символические ссылки.
  - setResolveLink
```
public void setResolveLink(boolean resolveLink)
```
    "Разрешать" символические ссылки.
    
    Parameters:
    
    resolveLink - "Разрешать" символические ссылки.
    
    See Also:
    
    isResolveLink()
  - getMaxRecusiveLinkLevel
```
public int getMaxRecusiveLinkLevel()
```
    Максимальная глубина вложенности символических ссылок.
    -1 - не органичено. По умолчанию 100
    
    Returns:
    
    Максимальная глубина вложенности символических ссылок
  - setMaxRecusiveLinkLevel
```
public void setMaxRecusiveLinkLevel(int maxRecusiveLinkLevel)
```
    Максимальная глубина вложенности символических ссылок.
    
    Parameters:
    
    maxRecusiveLinkLevel - Максимальная глубина вложенности символических ссылок.
    -1 - не органичено.
  - isUseCanonicalPath
```
public boolean isUseCanonicalPath()
```
    Приводить пути файлов к канонической форме, по умолч. true.
    
    Returns:
    
    Приводить пути файлов к канонической форме
  - setUseCanonicalPath
```
public void setUseCanonicalPath(boolean useCanonicalPath)
```
    Приводить пути файлов к канонической форме
    
    Parameters:
    
    useCanonicalPath - Приводить пути файлов к канонической форме
  - isUseAbsolutePath
```
public boolean isUseAbsolutePath()
```
    Приводить пути файлов к абсолютной форме, по умолч. false.
    
    Returns:
    
    Приводить пути файлов к абсолютной форме
  - setUseAbsolutePath
```
public void setUseAbsolutePath(boolean useCanonicalPath)
```
    Приводить пути файлов к абсолютной форме
    
    Parameters:
    
    useCanonicalPath - Приводить пути файлов к абсолютной форме
  - resolveLink
```
protected File resolveLink(ResolveLink<File> rl,
                           int currentResolve,
                           int maxResolve)
```
    Рекурсивно разрешает ссылки
    
    Parameters:
    
    rl - Получение ссылки
    
    currentResolve - текущая итерация
    
    maxResolve - макс. кол-во итераций или -1
    
    Returns:
    
    Ссылка или null
  - getFilter
```
public xyz.cofe.collection.Predicate<Stack<File>> getFilter()
```
    Вызывается перед входом в каталог для проверки необходимости войти
    
    Returns:
    
    Предикат входа в каталог
  - setFilter
```
public void setFilter(xyz.cofe.collection.Predicate<Stack<File>> filter)
```
    Вызывается перед входом в каталог для проверки необходимости войти
    
    Parameters:
    
    filter - Предикат входа в каталог
  - walk
```
public void walk(File root)
```
    Осуществляет обход каталога, вызывает методы enter/exit
    
    Parameters:
    
    root - точка с которой начиается обход
    
    See Also:
    
    enter(java.util.Stack), exit(java.util.Stack)
  - treeWalkIterable
```
public Iterable<xyz.cofe.collection.iterators.TreeWalk<File>> treeWalkIterable(File root)
```
  - walkIterable
```
public Iterable<File> walkIterable(File root)
```
    Возвращает последовательность файлов/каталогов (включая вложенгные)
    
    Parameters:
    
    root - точка с которой начиается обход
    
    Returns:
    
    последовательность файлов/каталогов

resolveLink = false	resolveLink = true
/A/ /A/1 /A/link/ /A/link/2 /A/link/3 /B/ /B/2 /B/3	/A/ /A/1 /B/ /B/2 /B/3

Class FileVisitor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

filter

Constructor Detail

FileVisitor

FileVisitor

Method Detail

clone

clone

enter

exit

error

getVisitHistory

getErrorBehavior

setErrorBehavior

isCheckHistory

setCheckHistory

isFollowLink

setFollowLink

isResolveLink

setResolveLink

getMaxRecusiveLinkLevel

setMaxRecusiveLinkLevel

isUseCanonicalPath

setUseCanonicalPath

isUseAbsolutePath

setUseAbsolutePath

resolveLink

getFilter

setFilter

walk

treeWalkIterable

walkIterable