Package Torello.JavaDoc

Enum SummaryTableHTML.ColNames

java.lang.Object

java.lang.Enum<SummaryTableHTML.ColNames>

Torello.JavaDoc.SummaryTableHTML.ColNames

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SummaryTableHTML.ColNames>

Enclosing class:

SummaryTableHTML<ENTITY extends Declaration>

public static enum SummaryTableHTML.ColNames
extends java.lang.Enum<SummaryTableHTML.ColNames>

Column-Names for the varies types of columns in a Summary-Table

For each of the "Entity Kinds", these are the standard column names which are present inside of a typical Java-Doc Summary-Table. Note that, generally, each of these "Entities" have very similar (if not, identical) Column-Names. Only the last two entries in this table differ at all:

Summary-Kind	Columns
Entity.FIELD:	3 columns (Modifier/Type, Field & Description)
Entity.METHOD:	3 columns (Modifier/Type, Method & Description)
Entity.ANNOTATION_ELEM:	3 columns (Modifier/Type, Required-Element or Optional-Element & Description)
Entity.INNER_CLASS:	3 columns (Modifier, Class & Description)
Entity.ENUM_CONSTANT:	2 columns (Name & Description)
Entity.CONSTRUCTOR:	VARIES Sometimes "Modifier/Type" is included, and Sometimes not!

Hi-Lited Source-Code:

• View Here: Torello/JavaDoc/SummaryTableHTML.java
• Open New Browser-Tab: Torello/JavaDoc/SummaryTableHTML.java

File Size: 3,475 Bytes Line Count: 85 '\n' Characters Found

Enum Constant Summary

Enum Constants

Enum Constant
Class
Constructor
Description
EnumConstant
Field
Interface
Method
Modifier
ModifierType
OptionalElement
RequiredElement

Field Summary

Fields

Modifier and Type	Field
String	colName

Method Summary

Modifier and Type	Method
static SummaryTableHTML.ColNames	findCol(String colName)
static SummaryTableHTML.ColNames	valueOf(String name)
static SummaryTableHTML.ColNames[]	values()

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Method

🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Method

Field

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Field

Constructor

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Constructor

EnumConstant

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames EnumConstant

OptionalElement

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames OptionalElement

RequiredElement

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames RequiredElement

Interface

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Interface

Class

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Class

Modifier

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Modifier

ModifierType

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames ModifierType

Description

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static final SummaryTableHTML.ColNames Description

Field Detail

colName

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String colName

Code:

Exact Field Declaration Expression:

 public final String colName;

Method Detail

values

🡅 🡇 ⇈ 🗕 🗗 🗖

public static SummaryTableHTML.ColNames[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SummaryTableHTML.ColNames c : SummaryTableHTML.ColNames.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

🡅 🡇 ⇈ 🗕 🗗 🗖

public static SummaryTableHTML.ColNames valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

findCol

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static SummaryTableHTML.ColNames findCol(java.lang.String colName)

Code:

Exact Method Body:

 return ColNames.namesTM.get(colName);