|
WEB4J Development Tools 4.10.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objecthirondelle.web4jtools.metrics.base.FileInfo
public final class FileInfo
Model Object for basic File Information.
Constructor Summary | |
---|---|
FileInfo(File aFile)
Full constructor. |
Method Summary | |
---|---|
boolean |
equals(Object aThat)
|
String |
getContent()
Return the contents of the file as a single String (source files only). |
SafeText |
getExtension()
Return the file extension. |
static String |
getIgnorableFiles()
Returned the list of ignorable files, as configured in web.xml. |
static String |
getImageFileExtensions()
Return the list of extensions for image files, as configured in web.xml. |
Date |
getLastModified()
Return the date the file was last modified. |
static String |
getMarkupFileExtensions()
Return the list of extensions for markup files, as configured in web.xml. |
SafeText |
getName()
Return the absolute path name of the file. |
Integer |
getNumCommentLines()
Return the number of comments (java files only) |
Integer |
getNumLines()
Return the number of lines (source files only) |
Integer |
getNumTabs()
Return the number of tab characters (source files only). |
Integer |
getPercentComments()
Return the percentage of comments as part of total lines (java files only) |
SafeText |
getSimpleName()
Return the simple name of the file, without path information. |
Long |
getSize()
Return the size of the file in bytes. |
static String |
getSourceFileExtensions()
Return the list of extensions for source files, as configured in web.xml. |
String |
getSpecification()
Return the name and version of a .jar file's specification (.jar files only). |
int |
hashCode()
|
static boolean |
isIgnorable(File aFile)
Determine if a file is an 'ignorable' file (such as a .class file, for instance.) See getIgnorableFiles() . |
Boolean |
isImageFile()
Return true only if the extension matches one of the image file extensions configured in web.xml. |
Boolean |
isJarFile()
Return true only if the file extension is '.jar' |
Boolean |
isJavaClassFile()
Return true only if the file extension is '.class' |
Boolean |
isJavaSourceFile()
Return true only if the file extension is '.java' |
Boolean |
isMarkupFile()
Return true only if the extension matches one of the markup file extensions configured in web.xml. |
Boolean |
isSourceFile()
Return true only if the extension matches one of the source file extensions configured in web.xml. |
Boolean |
isUnitTest()
Return true only if the file contains idenifier text configured in web.xml (java files only). |
static void |
readConfig(ServletConfig aConfig)
Read in config from web.xml. |
String |
toString()
|
Methods inherited from class Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileInfo(File aFile)
Method Detail |
---|
public static void readConfig(ServletConfig aConfig)
Called only during startup.
public static String getIgnorableFiles()
public static String getSourceFileExtensions()
public static String getImageFileExtensions()
public static String getMarkupFileExtensions()
public static boolean isIgnorable(File aFile)
getIgnorableFiles()
.
public SafeText getName()
public SafeText getSimpleName()
public Long getSize()
public Date getLastModified()
public SafeText getExtension()
public Boolean isSourceFile()
getSourceFileExtensions()
.
public Boolean isImageFile()
getImageFileExtensions()
.
public Boolean isMarkupFile()
getMarkupFileExtensions()
.
public Boolean isJavaSourceFile()
public Boolean isJavaClassFile()
public Boolean isJarFile()
public Integer getNumLines()
public Integer getNumCommentLines()
public Integer getPercentComments()
public Boolean isUnitTest()
public String getSpecification()
public Integer getNumTabs()
public String getContent()
public String toString()
toString
in class Object
public boolean equals(Object aThat)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
WEB4J Development Tools 4.10.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |