FileVisitor

java.lang.Object
- net.algart.lib.FileVisitor

Direct Known Subclasses:

FileVisitor.Filtered, FileVisitor.Mover
```
public abstract class FileVisitor
extends java.lang.Object
```
Implementation of visitor pattern for scanning all files in some directory.

Version:

1.0

Author:

Daniel Alievsky

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileVisitor.Copier`
`static class`	`FileVisitor.Filtered`
`static interface`	`FileVisitor.Listable`
`static class`	`FileVisitor.Lister`
`static class`	`FileVisitor.Mover`
`static class`	`FileVisitor.Remover`

Field Summary

Fields
Modifier and Type Field and Description

static int DEBUG_LEVEL

Fields
Modifier and Type	Field and Description
`static int`	`DEBUG_LEVEL`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FileVisitor(java.io.File root)
Inheritors should call this constructor with the root of the file tree that should be scanned.

Constructors
Modifier	Constructor and Description
`protected`	`FileVisitor(java.io.File root)` Inheritors should call this constructor with the root of the file tree that should be scanned.

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`depth()`
`boolean`	`equals(java.lang.Object obj)` Determines whether or not two objects are equal.
`void`	`execute()`
`protected boolean`	`executeAlternate()`
`boolean`	`executeInProgress()`
`boolean`	`executeWasCalled()`
`protected Directory[]`	`getLevels()`
`int`	`hashCode()` Returns the hash code for this object.
`static void`	`main(java.lang.String[] argv)`
`protected Directory`	`parent()` Returns the current subdirectory that is scanned by this visitor now.
`static void`	`removeOnShutdown(java.io.File f)` This method is an analog of the standard `f.deleteOnExit()`: it plans removing `f` on the moment before the shutdown of Java Virtual Machine.
`java.io.File`	`root()` Returns the root of file tree that is scanned by this visitor.
`java.lang.String`	`toString()` Returns a string representation of this object.
`protected abstract void`	`visitDirectoryAfter(Directory d, java.lang.Object savedContext)`
`protected abstract java.lang.Object`	`visitDirectoryBefore(Directory d)`
`protected abstract void`	`visitFile(java.io.File f)`
`protected void`	`visitRootAfter()`

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

- Field Detail
  - DEBUG_LEVEL
```
public static final int DEBUG_LEVEL
```
- Constructor Detail
  - FileVisitor
```
protected FileVisitor(java.io.File root)
```
    Inheritors should call this constructor with the root of the file tree that should be scanned.
    
    Parameters:
    root - the root of file tree that should be scanned
    
    Throws:
    
    java.lang.NullPointerException - if the argument is null
- Method Detail
  - root
```
public final java.io.File root()
```
    Returns the root of file tree that is scanned by this visitor.
    
    Returns:
    the root of file tree that is scanned by this visitor
  - parent
```
protected final Directory parent()
```
    Returns the current subdirectory that is scanned by this visitor now. It is changed while the visitor scans subdirectories recursively.
    
    Returns:
    the current subdirectory that is scanned by this visitor now.
  - depth
```
protected final int depth()
```
  - getLevels
```
protected final Directory[] getLevels()
```
  - visitFile
```
protected abstract void visitFile(java.io.File f)
                           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - visitDirectoryBefore
```
protected abstract java.lang.Object visitDirectoryBefore(Directory d)
                                                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - visitDirectoryAfter
```
protected abstract void visitDirectoryAfter(Directory d,
                       java.lang.Object savedContext)
                                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - visitRootAfter
```
protected void visitRootAfter()
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - executeAlternate
```
protected boolean executeAlternate()
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - execute
```
public final void execute()
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - executeWasCalled
```
public final boolean executeWasCalled()
```
  - executeInProgress
```
public final boolean executeInProgress()
```
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A string representation of this object
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code for this object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether or not two objects are equal. Two instances are equal if all arguments passed to their constructors were equal.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - An object to be compared with this instance
    
    Returns:
    true if the argument has the same type FileVisitor and is equal to this instance
  - removeOnShutdown
```
public static void removeOnShutdown(java.io.File f)
```
    This method is an analog of the standard f.deleteOnExit(): it plans removing f on the moment before the shutdown of Java Virtual Machine. But, unlike that method, this one compeletely removes f also in a case when it is a directory: then it is removed recursively including all files and subdirectories.
    
    Parameters:
    f - The file or directory that will be removed before JVM shutdown
  - main
```
public static void main(java.lang.String[] argv)
```

Class FileVisitor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG_LEVEL

Constructor Detail

FileVisitor

Method Detail

root

parent

depth

getLevels

visitFile

visitDirectoryBefore

visitDirectoryAfter

visitRootAfter

executeAlternate

execute

executeWasCalled

executeInProgress

toString

hashCode

equals

removeOnShutdown

main