Package uk.ac.starlink.ttools.build
Class Heading
- java.lang.Object
-
- uk.ac.starlink.ttools.build.Heading
-
public class Heading extends java.lang.Object
Enumeration class describing the function categories used by the JEL-accessible methods.- Since:
- 2 Sep 2004
- Author:
- Mark Taylor (Starlink)
-
-
Field Summary
Fields Modifier and Type Field Description static Heading
ACTIVATION
Heading for category of functions available only for activation.static Heading[]
ALL_HEADINGS
Array containing all known heading instances.static Heading
GENERAL
Heading for general category of functions.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns HTML description string.java.lang.String
getDocSuffix()
Returns unique text suitable for forming a filename.java.lang.String
getUserString()
Returns heading text.java.lang.String
toString()
-
-
-
Field Detail
-
GENERAL
public static final Heading GENERAL
Heading for general category of functions.
-
ACTIVATION
public static final Heading ACTIVATION
Heading for category of functions available only for activation.
-
ALL_HEADINGS
public static final Heading[] ALL_HEADINGS
Array containing all known heading instances.
-
-
Method Detail
-
getUserString
public java.lang.String getUserString()
Returns heading text.
-
getDocSuffix
public java.lang.String getDocSuffix()
Returns unique text suitable for forming a filename.
-
getDescription
public java.lang.String getDescription()
Returns HTML description string.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-