java.lang.Object
- Torello.JavaDoc.Stats

All Implemented Interfaces:

java.io.Serializable
```
public class Stats
extends java.lang.Object
implements java.io.Serializable
```
Maintains a suite of statistics about all Java project-wide source-code files.
As the Upgrade Processors are executed, this class maintains a few statistics about the build, and produces the Stats HTML instance, which is subsequently linked to a 'Stats' button on output Java Doc Web-Pages - and also returned to the user after calling the ugrader.

This class keeps a running log of upgrade-statistics.

See Also:

Serialized Form
Hi-Lited Source-Code:
- View Here: Torello/JavaDoc/Stats.java
- Open New Browser-Tab: Torello/JavaDoc/Stats.java
File Size: 22,320 Bytes Line Count: 463 '\n' Characters Found

Field Summary

Serializable ID

Modifier and Type	Field
`protected static long`	`serialVersionUID`

Package-Name - is null if this is the 'Global Stats' Instance
Modifier and Type	Field
`String`	`packageName`

TreeMap of all Package-Level Stats Instances
Modifier and Type	Field
`ReadOnlyMap<String,Stats>`	`packageStatsMap`

Source File Statistics
Modifier and Type	Field
`int`	`numBytes`
`int`	`numLines`

Method Statistics
Modifier and Type	Field
`int`	`numDocumentedMethods`
`int`	`numFinalMethods`
`int`	`numHiLitedMethods`
`int`	`numMethods`
`int`	`numPrivateMethods`
`int`	`numProtectedMethods`
`int`	`numPublicMethods`
`int`	`numStaticMethods`

Constructor Statistics
Modifier and Type	Field
`int`	`numConstructors`
`int`	`numDocumentedConstructors`
`int`	`numFinalConstructors`
`int`	`numHiLitedConstructors`
`int`	`numPrivateConstructors`
`int`	`numProtectedConstructors`
`int`	`numPublicConstructors`

Field Statistics
Modifier and Type	Field
`int`	`numDocumentedFields`
`int`	`numFields`
`int`	`numFinalFields`
`int`	`numHiLitedFields`
`int`	`numPrivateFields`
`int`	`numProtectedFields`
`int`	`numPublicFields`
`int`	`numStaticFields`
`int`	`numTransientFields`
`int`	`numVolatileFields`

Enum-Constant Statistics
Modifier and Type	Field
`int`	`numDocumentedEnumConstants`
`int`	`numEnumConstants`
`int`	`numHiLitedEnumConstants`

Annotation-Element Statistics
Modifier and Type	Field
`int`	`numAnnotationElems`
`int`	`numDocumentedAnnotationElems`
`int`	`numHiLitedAnnotationElems`

Other Statistics
Modifier and Type	Field
`int`	`numHiLitedDivs`

Global <EMBED>-Tag & Count Tables
Modifier and Type	Field
`ReadOnlyMap<String,Integer>`	`globalTagsCount`
`ReadOnlyMap<String,String>`	`globalTagsMap`

Package-Level <EMBED>-Tag & Count Tables
Modifier and Type	Field
`ReadOnlyMap<String,Integer>`	`packageTagsCount`
`ReadOnlyMap<String,String>`	`packageTagsMap`

Method Summary

Methods: class java.lang.Object

Modifier and Type Method

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    protected static final long serialVersionUID
    
    This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
    
    See Also:
    
    Constant Field Values
    
    Code:
    
    Exact Field Declaration Expression:
    
    protected static final long serialVersionUID = 1;
  - packageName
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final java.lang.String packageName
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final String packageName;
  - packageStatsMap
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final ReadOnlyMap<java.lang.String,Stats> packageStatsMap
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final ReadOnlyMap<String, Stats> packageStatsMap;
  - globalTagsMap
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final ReadOnlyMap<java.lang.String,java.lang.String> globalTagsMap
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final ReadOnlyMap<String, String> globalTagsMap;
  - globalTagsCount
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final ReadOnlyMap<java.lang.String,java.lang.Integer> globalTagsCount
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final ReadOnlyMap<String, Integer> globalTagsCount;
  - packageTagsMap
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final ReadOnlyMap<java.lang.String,java.lang.String> packageTagsMap
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final ReadOnlyMap<String, String> packageTagsMap;
  - packageTagsCount
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final ReadOnlyMap<java.lang.String,java.lang.Integer> packageTagsCount
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final ReadOnlyMap<String, Integer> packageTagsCount;
  - numLines
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numLines
    
    Maintains A count of the total number of lines of '.java' files.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numLines;
  - numBytes
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numBytes
    
    Maintains A count of the total number of bytes of '.java' files.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numBytes;
  - numHiLitedDivs
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedDivs
    
    Maintains A count of the total number of HiLited HTML <DIV> Elements.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedDivs;
  - numMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numMethods
    
    Maintains A count of the total number of methods found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numMethods;
  - numConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numConstructors
    
    Maintains A count of the total number of constructors found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numConstructors;
  - numFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numFields
    
    Maintains A count of the total number of fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numFields;
  - numAnnotationElems
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numAnnotationElems
    
    Maintains A count of the total number of annotation-elements found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numAnnotationElems;
  - numEnumConstants
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numEnumConstants
    
    Maintains A count of the total number of enum-constants found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numEnumConstants;
  - numHiLitedMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedMethods
    
    Maintains A count of the total number of method bodies hilited by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedMethods;
  - numHiLitedConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedConstructors
    
    Maintains A count of the total number of constructor bodies hilited by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedConstructors;
  - numHiLitedFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedFields
    
    Maintains A count of the total number of field declarations hilited by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedFields;
  - numHiLitedAnnotationElems
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedAnnotationElems
    
    A count of the total number of annotation-element declarations hilited by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedAnnotationElems;
  - numHiLitedEnumConstants
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numHiLitedEnumConstants
    
    A count of the total number of enumeration-constant declarations hilited by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numHiLitedEnumConstants;
  - numDocumentedMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numDocumentedMethods
    
    Maintains A count of the total number of methods that were documented by Java Doc.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numDocumentedMethods;
  - numDocumentedConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numDocumentedConstructors
    
    Maintains A count of the total number of constructors that were documented by Java Doc.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numDocumentedConstructors;
  - numDocumentedFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numDocumentedFields
    
    Maintains A count of the total number of fields that were documented by Java Doc.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numDocumentedFields;
  - numDocumentedAnnotationElems
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numDocumentedAnnotationElems
    
    A count of the total number of annotation-elements that were documented by Java Doc.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numDocumentedAnnotationElems;
  - numDocumentedEnumConstants
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numDocumentedEnumConstants
    
    A count of the total number of annotation-elements that were documented by Java Doc.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numDocumentedEnumConstants;
  - numStaticMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numStaticMethods
    
    Maintains A count of the total number of static methods found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numStaticMethods;
  - numStaticFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numStaticFields
    
    Maintains A count of the total number of static fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numStaticFields;
  - numFinalMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numFinalMethods
    
    Maintains A count of the total number of final methods found by the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numFinalMethods;
  - numFinalConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numFinalConstructors
    
    Maintains A count of the total number of final constructors found by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numFinalConstructors;
  - numFinalFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numFinalFields
    
    Maintains A count of the total number of final fields found by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numFinalFields;
  - numPublicMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPublicMethods
    
    Maintains A count of the total number of public methods found by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPublicMethods;
  - numPublicConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPublicConstructors
    
    Maintains A count of the total number of public constructors found by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPublicConstructors;
  - numPublicFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPublicFields
    
    Maintains A count of the total number of public fields found by the upgrader.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPublicFields;
  - numProtectedMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numProtectedMethods
    
    Maintains The total number of protected methods found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numProtectedMethods;
  - numProtectedConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numProtectedConstructors
    
    Maintains The total number of protected constructors found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numProtectedConstructors;
  - numProtectedFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numProtectedFields
    
    Maintains The total number of protected fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numProtectedFields;
  - numPrivateMethods
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPrivateMethods
    
    Maintains The total number of private methods found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPrivateMethods;
  - numPrivateConstructors
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPrivateConstructors
    
    Maintains The total number of private constructors found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPrivateConstructors;
  - numPrivateFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numPrivateFields
    
    Maintains The total number of private fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numPrivateFields;
  - numTransientFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numTransientFields
    
    Maintains A count of the total number of transient fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numTransientFields;
  - numVolatileFields
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public final int numVolatileFields
    
    Maintains A count of the total number of volatile fields found during the upgrade.
    
    Code:
    
    Exact Field Declaration Expression:
    
    public final int numVolatileFields;
- Method Detail
  - toString
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public java.lang.String toString()
    
    Generates a String that enapsulates all of the counters / running-totals inside this data statistic class.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of this class. Only includes statistics about use of methods, constructors, fields etc... DOES NOT INCLUDE statistics regarding the use of the <EMBED CLASS='external-html' ...> tags.
    
    Code:
    
    Exact Method Body:
    
    return Torello.JDUInternal.Features.STATS.S_ToString.get(this);

Fields
ReadOnlyMap	globalTagsCount
ReadOnlyMap	globalTagsMap
int	numAnnotationElems
int	numBytes
int	numConstructors
int	numDocumentedAnnotationElems
int	numDocumentedConstructors
int	numDocumentedEnumConstants
int	numDocumentedFields
int	numDocumentedMethods
int	numEnumConstants
int	numFields
int	numFinalConstructors
int	numFinalFields
int	numFinalMethods
int	numHiLitedAnnotationElems
int	numHiLitedConstructors
int	numHiLitedDivs
int	numHiLitedEnumConstants
int	numHiLitedFields
int	numHiLitedMethods
int	numLines
int	numMethods
int	numPrivateConstructors
int	numPrivateFields
int	numPrivateMethods
int	numProtectedConstructors
int	numProtectedFields
int	numProtectedMethods
int	numPublicConstructors
int	numPublicFields
int	numPublicMethods
int	numStaticFields
int	numStaticMethods
int	numTransientFields
int	numVolatileFields
String	packageName
ReadOnlyMap	packageStatsMap
ReadOnlyMap	packageTagsCount
ReadOnlyMap	packageTagsMap

Class Stats

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

packageName

packageStatsMap

globalTagsMap

globalTagsCount

packageTagsMap

packageTagsCount

numLines

numBytes

numHiLitedDivs

numMethods

numConstructors

numFields

numAnnotationElems

numEnumConstants

numHiLitedMethods

numHiLitedConstructors

numHiLitedFields

numHiLitedAnnotationElems

numHiLitedEnumConstants

numDocumentedMethods

numDocumentedConstructors

numDocumentedFields

numDocumentedAnnotationElems

numDocumentedEnumConstants

numStaticMethods

numStaticFields

numFinalMethods

numFinalConstructors

numFinalFields

numPublicMethods

numPublicConstructors

numPublicFields

numProtectedMethods

numProtectedConstructors

numProtectedFields

numPrivateMethods

numPrivateConstructors

numPrivateFields

numTransientFields

numVolatileFields

Method Detail

toString