org.sdmlib.doc.util

Class JavaDocFileVisitor

java.lang.Object

org.sdmlib.doc.util.JavaDocFileVisitor

All Implemented Interfaces:

java.nio.file.FileVisitor<java.nio.file.Path>

public class JavaDocFileVisitor
extends java.lang.Object
implements java.nio.file.FileVisitor<java.nio.file.Path>

This class is the visitor which analyse the java doc in a single file

Constructor Summary

Constructors

Constructor and Description
JavaDocFileVisitor(java.util.ArrayList<java.lang.String> traceInf, boolean printOnConsole, boolean fullCheck) Construct a new java doc file visitor which checks the current file for the java doc

Method Summary

Modifier and Type	Method and Description
java.nio.file.FileVisitResult	postVisitDirectory(java.nio.file.Path dir, java.io.IOException exc)
java.nio.file.FileVisitResult	preVisitDirectory(java.nio.file.Path dir, java.nio.file.attribute.BasicFileAttributes attrs)
java.nio.file.FileVisitResult	visitFile(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attrs)
java.nio.file.FileVisitResult	visitFileFailed(java.nio.file.Path file, java.io.IOException exc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaDocFileVisitor

public JavaDocFileVisitor(java.util.ArrayList<java.lang.String> traceInf,
                          boolean printOnConsole,
                          boolean fullCheck)

Construct a new java doc file visitor which checks the current file for the java doc

Parameters:

traceInf - The informations about the current searching

printOnConsole - Should everything printed on console

fullCheck - If true everything will checked in every class, if false only created java doc will validate.

Method Detail

visitFile

public java.nio.file.FileVisitResult visitFile(java.nio.file.Path file,
                                               java.nio.file.attribute.BasicFileAttributes attrs)
                                        throws java.io.IOException

Specified by:

visitFile in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

preVisitDirectory

public java.nio.file.FileVisitResult preVisitDirectory(java.nio.file.Path dir,
                                                       java.nio.file.attribute.BasicFileAttributes attrs)
                                                throws java.io.IOException

Specified by:

preVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

visitFileFailed

public java.nio.file.FileVisitResult visitFileFailed(java.nio.file.Path file,
                                                     java.io.IOException exc)
                                              throws java.io.IOException

Specified by:

visitFileFailed in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

postVisitDirectory

public java.nio.file.FileVisitResult postVisitDirectory(java.nio.file.Path dir,
                                                        java.io.IOException exc)
                                                 throws java.io.IOException

Specified by:

postVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Throws:

java.io.IOException