Package Torello.JavaDoc
Class ParsedFile
- java.lang.Object
-
- Torello.JavaDoc.ParsedFile
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
JavaDocHTMLFile
public abstract class ParsedFile extends java.lang.Object implements java.io.Serializable
Parent-class ofJavaDocHTMLFileand the source-code parsing classes.
This class is abstract and there are two primary classes which extend it. This class is designed to hold all of the information - injava.lang.Stringformat - about a Java class, interface or enumerated type. This information generally includes lists of fields, methods and constructor declarations. This class acceptsString's(in its constructor) from the two classes which extend it. ThoseString'sare found by the JavaParser Tool.
The easiest way to think about this is that this is a (tremendously) pared down version of the JavaParser Library, that holds the essential information need to HiLite & Update a JavaDoc Web-Page using thisUpgradeTool. The standard Java Reflection API, inside Java Packagejava.lang.reflect.*is capable of supplying all of the method, constructor and field names (and parameters) for just about any Java Class. However, what the Reflect API cannot supply are Method Bodies & Constructor Bodies as instances ofjava.lang.String. These are required so that they may be syntax hilited by the hiliter, and that's what makes the Java Parser Library JAR necessary.
This class serves as the root-class for both parsed Java-Doc HTML Pages, and parsed Java Source-Code'.java'pages.- See Also:
- Serialized Form
Hi-Lited Source-Code:- View Here: Torello/JavaDoc/ParsedFile.java
- Open New Browser-Tab: Torello/JavaDoc/ParsedFile.java
File Size: 36,143 Bytes Line Count: 866 '\n' Characters Found
-
-
Field Summary
Serializable ID Modifier and Type Field static longserialVersionUIDCIET Name & Package Name Modifier and Type Field StringfullNameNoGenericsStringjavaSrcFileAsStrStringpackageNameStringsimpleNameWithContainersAndGenericsStringsimpleNameWithPossibleContainersStringtypeNameJOWBasic Source-File Data Modifier and Type Field CIETcietReadOnlyList<String>containerClassesStringfileNameReadOnlyList<String>genericParametersBoolean Flags Modifier and Type Field booleanisGenericbooleanisInnerSource-File Reflected-Entites / Reflected-Members Lists Modifier and Type Field ReadOnlyList<AnnotationElem>annotationElemsReadOnlyList<Constructor>constructorsReadOnlyList<EnumConstant>enumConstantsReadOnlyList<Field>fieldsReadOnlyList<Method>methodsReadOnlyList<NestedType>nestedTypesSource-Code Line-Number Information Modifier and Type Field intendLineNumberintjdEndLineNumberintjdStartLineNumberintstartLineNumberSource-Code Size Modifier and Type Field inttypeLineCountinttypeSizeCharsProtected, Internally Used Modifier and Type Field protected TypeAnnotationMirrorstypeAnnotationMirrors
-
Constructor Summary
Constructors Modifier Constructor protectedParsedFile(String fileName, String simpleNameWithContainersAndGenerics, String packageName, CIET ciet, ReadOnlyList<String> genericParameters, String fullNameNoGenerics, String typeNameJOW, int startLineNumber, int endLineNumber, int jdStartLineNumber, int jdEndLineNumber, int typeLineCount, int typeSizeChars, String javaSrcFileAsStr, ReadOnlyList<Method> methods, ReadOnlyList<Field> fields, ReadOnlyList<Constructor> constructors, ReadOnlyList<EnumConstant> enumConstants, ReadOnlyList<AnnotationElem> annotationElems, ReadOnlyList<NestedType> nestedTypes)
-
Method Summary
Methods for: Method'sModifier and Type Method MethodfindMethod(Torello.JDUInternal.Parse.HTML.Signature.D1_CallableSignature cSig)Stream<Method>findMethods(String methodName)Methods for: Field'sModifier and Type Method FieldfindField(String name)Methods for: Constructor'sModifier and Type Method ConstructorfindConstructor(Torello.JDUInternal.Parse.HTML.Signature.D1_CallableSignature cSig)Stream<Constructor>findConstructors(int numParameters)Methods for: AnnotationElem'sModifier and Type Method AnnotationElemfindAnnotationElem(String name)Methods for: EnumConstant'sModifier and Type Method EnumConstantfindEnumConstant(String name)Methods for: NestedType'sModifier and Type Method NestedTypefindNestedType(String name)toString() Methods Modifier and Type Method StringabbreviatedSummary(int lineWidth)StringquickSummary()StringtoString()StringtoString(int flags)
-
-
-
Field Detail
-
serialVersionUID
public static final long serialVersionUID
This fulfils the SerialVersion UID requirement for all classes that implement Java'sinterface java.io.Serializable. Using theSerializableImplementation 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:
public static final long serialVersionUID = 1;
-
typeAnnotationMirrors
protected TypeAnnotationMirrors typeAnnotationMirrors
Stores information provided by the JavaDoc Upgrader Annotations. Note, this Annotation Mirror does not contain information about any / all annotations used inside of Java Source Code Files, but rather only the ones created by this API.
These include@StaticFunctionaland also@JDHeaderBackgroundImg- Code:
- Exact Field Declaration Expression:
protected TypeAnnotationMirrors typeAnnotationMirrors = null;
-
javaSrcFileAsStr
public final java.lang.String javaSrcFileAsStr
This field simply contains the entire contents of the'.java'Source-Code File from whence thisParsedFileinstance originated.
Note that for in for the sub-classJavaDocHTMLFile, when the HTML file which was parsed represents an inner-class / nested-type, this field will still contain the entire contents of the top-level enclosing java type (as aString) in this field.
For instance, if aJavaDocHTMLFile(which inherits this class,ParsedFile) instance had been generated for the Java-HTML inner-classTorello.HTML.Attributes.Filter, which happens to be a nested type of classTorello.HTML.Attributes, this field would contain the text-characters of the Source-FileTorello/HTML/Attributes.javainString-format (as character data).- Code:
- Exact Field Declaration Expression:
public final String javaSrcFileAsStr;
-
fileName
public final java.lang.String fileName
Contains the file-name from which this instance was derived- Code:
- Exact Field Declaration Expression:
public final String fileName;
-
simpleNameWithContainersAndGenerics
public final java.lang.String simpleNameWithContainersAndGenerics
Holds the name of a Class / CIET / Type. A'ParsedFile'represents a class, interface, or enumerated-type. This name stored in this field IS NOT the fully-qualified (Package-Name information included) name. The Java-Package in which this Class or Type resides isn't incorporated into the name stored in this field.
ThisString-Field will have any & all Generic Type Parameters appended to its name - if this CIET represents a generic with such Type-Parameters.
If thisCIET/Type represents a Nested-Class / Inner-Type, the names of the containingCIET/ Types are included in thisString-Field.Output Value Input CIET/ Type"Integer"interface java.lang.Integer"Vector<E>"class java.util.Vector<E>"Base.Decoder"class java.util.Base64.Decoder"Map.Entry<K, V>"interface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final String simpleNameWithContainersAndGenerics;
-
fullNameNoGenerics
public final java.lang.String fullNameNoGenerics
ThisString-Field holds the fully qualifiedCIETname - which simply means that any Java-Package information that is available shall be included in the name that is stored in this field. By implication, if the Package-Name is stored, then thisString-Field must also hold any Container-Class names for this CIET/Type - in cases where this type is, indeed, a nested or inner type.
If thisCIET-Type happens to be a Java Generic with Generic Type Parameters (the'E'in typejava.util.Vector<E>, this information WILL NOT include that text stored within thisString-Field.Output Value Input CIET/ Type"java.lang.Integer"interface java.lang.Integer"java.util.Vector"class java.util.Vector<E>"java.util.Base64.Decoder"class java.util.Base64.Decoder"java.util.Map.Entry"interface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final String fullNameNoGenerics;
-
simpleNameWithPossibleContainers
public final java.lang.String simpleNameWithPossibleContainers
This the same as thesimpleNameWithContainersAndGenericsfield, but leaves off the Generic Type-ParameterString's. If this class is representing aCIETType that happens to be a Nested-Type / Inner-Class, then the containingCIETname(s) ARE included in thisString-Field.Output Value Input CIET/ Type"Integer"interface java.lang.Integer"Vector"class java.util.Vector<E>"Base64.Decoder"class java.util.Base64.Decoder"Map.Entry"interface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final String simpleNameWithPossibleContainers;
-
typeNameJOW
public final java.lang.String typeNameJOW
JOW: Just One Word
The Java-Doc Upgrader utilizes a few naming conventions, one of which is that any time the acronym'JOW'is used, it is intending to provide a name to a Java-Type. Since there isn't an exact consensus on what information should be included in a Type-Name, the'JOW'Acronym simply implies that the simplest name possible (a single word name) is being stored in this field.
If this name is representing aCIET-Type that happens to be a Java-Generic, and having Generic-Type Parameters, suchString-Text WILL NOT be included in thisString-Field.
If this name is representing aCIET-Type that happens to be a Nested-Type / Inner-Class, then the containingCIETname(s) ARE NOT included in thisString-Field.
Package-Name information will also not be stored in this field.Output Value Input CIET/ Type"Integer"interface java.lang.Integer"Vector"class java.util.Vector<E>"Decoder"class java.util.Base64.Decoder"Entry"interface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final String typeNameJOW;
-
packageName
public final java.lang.String packageName
Holds the package-name. If thisParsedFilewere for classjava.lang.Stringthe'packageName'would be'java.lang'.- Code:
- Exact Field Declaration Expression:
public final String packageName;
-
ciet
-
isInner
public final boolean isInner
This identifies inner classes and interfaces.'isInner'Field ValueInput CIETfalseinterface java.lang.Integerfalseclass java.util.Vector<E>trueclass java.util.Base64.Decodertrueinterface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final boolean isInner;
-
containerClasses
public final ReadOnlyList<java.lang.String> containerClasses
This identifies inner classes and interfaces. For any class that is not an inner class, this will be a zero-lengthString[]array.'containerClasses'ValueInput CIET<EMPTY-LIST>interface java.lang.Integer<EMPTY-LIST>class java.util.Vector<E>{ "Base64" }class java.util.Base64.Decoder{ "Map" }interface java.util.Map.Entry<K, V>- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<String> containerClasses;
-
isGeneric
public final boolean isGeneric
This field will beTRUEanytime thegenericParametersfield has any elements.- Code:
- Exact Field Declaration Expression:
public final boolean isGeneric;
-
genericParameters
public final ReadOnlyList<java.lang.String> genericParameters
If this represents a Java Generic Class or Interface, with generic type information, the generic type parameters shall be saved here.- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<String> genericParameters;
-
startLineNumber
public final int startLineNumber
The line-number in the source-code file where this class definition actually begins.
Note that if this instance ofParsedFileis representing a Nessted-Type / Inner-Class, then this field will contain the line-number where that inner-type's definition begins inside the Enclosing-Class''.java'file.- Code:
- Exact Field Declaration Expression:
public final int startLineNumber;
-
endLineNumber
public final int endLineNumber
The line-number in the source-code file where this class definition ends. Often this will just be the line-number of the last line in the'.java'file.
If this is a Nested-Type, this field will contain the line-number where the definition of the Nested-type ends.- Code:
- Exact Field Declaration Expression:
public final int endLineNumber;
-
jdStartLineNumber
public final int jdStartLineNumber
The starting line-number of the JavaDoc Comment at the top of the class. If this class does not have a Java-Doc Comment, this field will contain-1.- Code:
- Exact Field Declaration Expression:
public final int jdStartLineNumber;
-
jdEndLineNumber
public final int jdEndLineNumber
The endiing line-number of the JavaDoc Comment at the top of the class. If this class does not have a Java-Doc Comment, this field will contain-1.- Code:
- Exact Field Declaration Expression:
public final int jdEndLineNumber;
-
typeLineCount
public final int typeLineCount
The number of lines of Source-Code inside this'.java'File. If this instance ofParsedFilerepresents an Inner-Type (Nested-Class), then this field will contain a value that corresponds only to the number of lines used by the Nested-Type within the context of the entire Enclosing-Class'.java'file.- Code:
- Exact Field Declaration Expression:
public final int typeLineCount;
-
typeSizeChars
public final int typeSizeChars
The number of characters / bytes of Source-Code inside this'.java'File. If this instance ofParsedFilerepresents an Inner-Type (Nested-Class), then this field will contain a value that corresponds only to the number of characters / bytes used by the Nested-Type within the context of the entire Enclosing-Class'.java'file.- Code:
- Exact Field Declaration Expression:
public final int typeSizeChars;
-
methods
public final ReadOnlyList<Method> methods
This is the list ofMethodinstances identified by the parser for thisParsedFile- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<Method> methods;
-
constructors
public final ReadOnlyList<Constructor> constructors
This is the list ofConstructorinstances identified by the parser for thisParsedFile- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<Constructor> constructors;
-
fields
public final ReadOnlyList<Field> fields
This is the list ofFieldinstances identified by the parser for thisParsedFile- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<Field> fields;
-
annotationElems
public final ReadOnlyList<AnnotationElem> annotationElems
This is the list ofAnnotationEleminstances identified by the parser for thisParsedFile
IMPORTANT: The vast majority of source-files will not contain anyAnnotationElem's. Unless the source-file used to build'this'was anannotationit would simply not be possible to define an AnnotationElem for theannotation- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<AnnotationElem> annotationElems;
-
enumConstants
public final ReadOnlyList<EnumConstant> enumConstants
This is the list ofEnumConstantinstances identified by the parser for thisParsedFile
IMPORTANT: The vast majority of source-files will not contain anyEnumConstant's. Unless the source-file used to build'this'was anenumit would simply not be possible to define an EnumConstant for theenum- See Also:
enumConstants- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<EnumConstant> enumConstants;
-
nestedTypes
public final ReadOnlyList<NestedType> nestedTypes
This is the list ofNestedTypeinstances identified by the parser for thisParsedFile- Code:
- Exact Field Declaration Expression:
public final ReadOnlyList<NestedType> nestedTypes;
-
-
Method Detail
-
findMethod
public Method findMethod (Torello.JDUInternal.Parse.HTML.Signature.D1_CallableSignature cSig)
Finds a Method having the characteristics specified by parameter'cSig'.- Parameters:
cSig- An internally generated representation of a Java-Method extrapolated from the information available on a Java-Doc HTML Detail Section- Returns:
- A method that matches the requested Method-Signature
- Code:
- Exact Method Body:
for (Method method : methods) if ( method.name.equals(cSig.name) && method.returnTypeJOW.equals(cSig.returnTypeJOW) && method.nearlyEqualsCallableSig(cSig) ) return method; return null;
-
findConstructor
public Constructor findConstructor (Torello.JDUInternal.Parse.HTML.Signature.D1_CallableSignature cSig)
Finds a Constructor having the characteristics specified by parameter'cSig'.- Parameters:
cSig- An internally generated representation of a Java-Constructor extrapolated from the information available on a Java-Doc HTML Detail Section- Returns:
- A Constructor that matches the requested Constructor-Signature
- Code:
- Exact Method Body:
for (Constructor ctor : constructors) if (ctor.nearlyEqualsCallableSig(cSig)) return ctor; return null;
-
findMethods
public java.util.stream.Stream<Method> findMethods (java.lang.String methodName)
Returns all internally-storedMethodinstances whoseMethod#namefield matches'name'- Parameters:
methodName- The name of theMethod- Returns:
- An instance of
Stream<Method>of allMethod'snamed'name' - See Also:
methods,Declaration.name- Code:
- Exact Method Body:
Stream.Builder<Method> b = Stream.builder(); for (Method method : methods) if (method.name.equals(methodName)) b.accept(method); return b.build();
-
findConstructors
public java.util.stream.Stream<Constructor> findConstructors (int numParameters)
Returns all internally-storedConstructorinstances for instances whose accepted parameters-list has a length equal tonumParameters.- Parameters:
numParameters- The number of parameters accepted by theConstructorbeing searched.- Returns:
- An instance of
Stream<Constructor>containing allConstructor'swhose number of parameterss equals'numParameters' - See Also:
constructors,Callable.numParameters()- Code:
- Exact Method Body:
Stream.Builder<Constructor> b = Stream.builder(); for (Constructor constructor : constructors) if (constructor.numParameters() == numParameters) b.accept(constructor); return b.build();
-
findField
public Field findField(java.lang.String name)
Returns the internally-storedFieldinstance whose name matches parameter'name'- Parameters:
name- The name of theField- Returns:
- The
Fieldwhosenamematches parameter'name'. If there is no suchFieldwith that name defined in this parsed-file, then null is returned. - See Also:
Declaration.name,fields- Code:
- Exact Method Body:
for (Field field : fields) if (field.name.equals(name)) return field; return null;
-
findAnnotationElem
public AnnotationElem findAnnotationElem(java.lang.String name)
Returns the internally-storedAnnotationEleminstance whose name matches parameter'name'
IMPORTANT: The vast majority of source-files will not contain anyAnnotationElem's. Unless the source-file used to build'this'was anannotationit would simply not be possible to define an AnnotationElem for theannotation- Parameters:
name- The name of theAnnotationElem- Returns:
- The
AnnotationElemwhosenamematches parameter'name'. If there is no suchAnnotationElemwith that name defined in this parsed-file, then null is returned. - See Also:
Declaration.name,annotationElems- Code:
- Exact Method Body:
for (AnnotationElem ae : annotationElems) if (ae.name.equals(name)) return ae; return null;
-
findEnumConstant
public EnumConstant findEnumConstant(java.lang.String name)
Returns the internally-storedEnumConstantinstance whose name matches parameter'name'
IMPORTANT: The vast majority of source-files will not contain anyEnumConstant's. Unless the source-file used to build'this'was anenumit would simply not be possible to define an EnumConstant for theenum- Parameters:
name- The name of theEnumConstant- Returns:
- The
EnumConstantwhosenamematches parameter'name'. If there is no suchEnumConstantwith that name defined in this parsed-file, then null is returned. - See Also:
Declaration.name,enumConstants- Code:
- Exact Method Body:
for (EnumConstant ec : enumConstants) if (ec.name.equals(name)) return ec; return null;
-
findNestedType
public NestedType findNestedType(java.lang.String name)
Returns the internally-storedNestedTypeinstance whose name matches parameter'name'- Parameters:
name- The name of theNestedType- Returns:
- The
NestedTypewhosenamematches parameter'name'. If there is no suchNestedTypewith that name defined in this parsed-file, then null is returned. - See Also:
Declaration.name,nestedTypes- Code:
- Exact Method Body:
for (NestedType nt : nestedTypes) if (nt.name.equals(name)) return nt; return null;
-
toString
public java.lang.String toString()
Turns aParsedFileresult object,'this', into aString. Passes'0'to the standard flags-print method.- Overrides:
toStringin classjava.lang.Object- Code:
- Exact Method Body:
return toString(0);
-
toString
public java.lang.String toString(int flags)
Turns aParsedFileresult object,'this', into ajava.lang.String.
This will check for the'UNIX_COLORS'flag inclass PF. If this flag is identified, then a few unix color codes are added to the output.
IMPORTANT NOTE: The value of this flag will be propagated to the individualtoString(int flag)methods in each of theMethod, Field, Constructoretc... -toString(flag)methods.- Returns:
- This returns a
Stringthat obeys the flag-requests by parameter flag. - See Also:
Method.toString(int),Constructor.toString(int),Field.toString(int)- Code:
- Exact Method Body:
StringBuilder sb = new StringBuilder(); boolean c = (flags & PF.UNIX_COLORS) > 0; StringBuilder typeParamsSB = new StringBuilder(); for (String p : genericParameters) typeParamsSB.append(p + ", "); String typeParamsStr = (typeParamsSB.length() > 0) ? typeParamsSB.subSequence(0, typeParamsSB.length() - 1).toString() : "-"; StringBuilder containerClassesSB = new StringBuilder(); for (String p : containerClasses) containerClassesSB.append(p + ", "); String containerClassesStr = (containerClassesSB.length() > 0) ? containerClassesSB.subSequence(0, containerClassesSB.length() - 1).toString() : "-"; sb.append( "******************************************************************\n" + "Fields in this 'ParsedFile' instance:\n" + "******************************************************************\n" + "fileName: " + fileName + '\n' + "simpleNameWithContainersAndGenerics: " + simpleNameWithContainersAndGenerics + '\n' + "CIET: " + ciet + '\n' + "packageName: " + packageName + '\n' + "simpleNameWithPossibleContainers: " + simpleNameWithPossibleContainers + '\n' + "fullNameNoGenerics: " + fullNameNoGenerics + '\n' + "isGeneric: " + isGeneric + '\n' + "Type Parameters: " + typeParamsStr + '\n' + "isInner: " + isInner + '\n' + "Container Classes: " + containerClassesStr + "\n" + "\n" + "fields.size(): " + fields.size() + '\n' + "methods.size(): " + methods.size() + '\n' + "constructors.size(): " + constructors.size() + '\n' + "annotationElems.size(): " + annotationElems.size() + '\n' + "enumConstants.size(): " + enumConstants.size() + '\n' + "nestedTypes.size(): " + nestedTypes.size() + "\n\n" ); if (methods.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Methods:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (Method m : methods) sb.append(m.toString(flags) + "\n\n"); } if (constructors.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Constructors:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (Constructor cs : constructors) sb.append(cs.toString(flags) + "\n\n"); } if (fields.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Fields:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (Field f : fields) sb.append(f.toString(flags) + "\n\n"); } if (annotationElems.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Annotation-Elements:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (AnnotationElem ae : annotationElems) sb.append(ae.toString(flags) + "\n\n"); } if (enumConstants.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Enumerated Constants:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (EnumConstant ec : enumConstants) sb.append(ec.toString(flags) + "\n\n"); } if (nestedTypes.size() > 0) { sb.append( "******************************************************************\n" + (c ? BRED : "") + "Nested Types:\n" + (c ? RESET : "") + "******************************************************************\n" ); for (NestedType nt : nestedTypes) sb.append(nt.toString(flags) + "\n\n"); } return sb.toString();
-
quickSummary
public java.lang.String quickSummary()
Provides a Quick Summary for this file.- Returns:
- The summary as a
java.lang.String. Nothing is actually printed by this method. - Code:
- Exact Method Body:
String typeParams = (genericParameters.size() == 0) ? "" : ("Generic Type-Parameters: " + StrCSV.toCSV(this.genericParameters, true, true, null) + '\n'); String ae = (annotationElems.size() == 0) ? "" : (", [" + BBLUE + StrPrint.zeroPad(annotationElems.size()) + RESET + "] Annotation-Elements"); String ec = (enumConstants.size() == 0) ? "" : (", [" + BBLUE + StrPrint.zeroPad(enumConstants.size()) + RESET + "] Enum-Constants"); String nt = (nestedTypes.size() == 0) ? "" : (", [" + BBLUE + StrPrint.zeroPad(nestedTypes.size()) + RESET + "] Nested-Types"); return "Name w/ Containers & Generics [" + BYELLOW + simpleNameWithContainersAndGenerics + RESET + "]\n" + "Name w/ Any Containers [" + BYELLOW + simpleNameWithPossibleContainers + RESET + "]\n" + "Name w/ Package-Info [" + BYELLOW + fullNameNoGenerics + RESET + "]\n" + "Package [" + BYELLOW + packageName + RESET + "]\n" + "CIET [" + BYELLOW + ciet + RESET + "]\n" + typeParams + '[' + BBLUE + StrPrint.zeroPad(fields.size()) + RESET + "] Fields, " + '[' + BBLUE + StrPrint.zeroPad(constructors.size()) + RESET + "] Constructors, " + '[' + BBLUE + StrPrint.zeroPad(methods.size()) + RESET + "] Methods" + ae + ec + nt + '\n';
-
abbreviatedSummary
public java.lang.String abbreviatedSummary(int lineWidth)
Provides a Vertical-List Abbreviated Summary for this file.- Parameters:
lineWidth- The number of characters wide the member-summary lines should be.- Returns:
- The summary as a
java.lang.String. Nothing is actually printed by this method. - Code:
- Exact Method Body:
String typeParams = (genericParameters.size() == 0) ? "" : ("Generic Type-Parameters: " + StrCSV.toCSV(this.genericParameters, true, true, null) + '\n'); String m = (methods.size() == 0) ? "Methods: *NONE*\n" : ("Methods:" + StrPrint.printListAbbrev (methods, lineWidth, 4, false, true, true) + '\n'); String f = (fields.size() == 0) ? "Fields: *NONE*\n" : ("Fields:" + StrPrint.printListAbbrev (fields, lineWidth, 4, false, true, true) + '\n'); String c = (constructors.size() == 0) ? "Constructors: *NONE*\n" : ("Constructors:" + StrPrint.printListAbbrev (constructors, lineWidth, 4, false, true, true) + '\n'); String ec = (enumConstants.size() == 0) ? "" : ("Enum-Constants:" + StrPrint.printListAbbrev (enumConstants, lineWidth, 4, false, true, true) + '\n'); String ae = (annotationElems.size() == 0) ? "" : ("Annotation-Elements:" + StrPrint.printListAbbrev (annotationElems, lineWidth, 4, false, true, true) + '\n'); String nt = (nestedTypes.size() == 0) ? "" : ('[' + BBLUE + StrPrint.zeroPad(nestedTypes.size()) + RESET + "] Nested-Types"); return "Name w/ Containers & Generics " + '[' + BYELLOW + simpleNameWithContainersAndGenerics + RESET + "]\n" + "Name w/ Any Containers " + '[' + BYELLOW + simpleNameWithPossibleContainers + RESET + "]\n" + "Package-Name Qualified " + '[' + BYELLOW + fullNameNoGenerics + RESET + "]\n" + "Package [" + BYELLOW + packageName + RESET + "]\n" + "CIET [" + BYELLOW + ciet + RESET + "]\n" + typeParams + m + f + c + ec + ae + nt + '\n';
-
-