org.erights.e.elib.base
Class MessageDesc

java.lang.Object
  |
  +--org.erights.e.elib.base.MessageDesc

All Implemented Interfaces:

Marker, Persistent, Serializable

public class MessageDesc

extends Object

implements Persistent

Safe:

See Also:

Serialized Form

Field Summary

private String	myDocComment
private ConstList	myParams
private Object	myRetType
private String	myVerb
private static StaticMaker	OptMessageDescMaker
(package private) static long	serialVersionUID

Fields inherited from interface org.erights.e.elib.serial.Persistent

HONORARY, HONORED_NAMES

Constructor Summary

MessageDesc(String docComment, String verb, ConstList params, Object retType)
Enabled: @param retType In order to avoid a circular dependency, this variable can hold a Class instead of a SlotGuard, in which case it will be converted to a SlotGuard as needed.

Method Summary

void	__printOn(TextWriter out) Enabled:
String	getDocComment() Enabled:
static StaticMaker	GetMessageDescMaker() Enabled:
ConstList	getParams() Enabled:
ValueGuard	getReturnType() Enabled:
String	getVerb() Enabled:
private void	printDeclOn(TextWriter out)
void	printHelpOn(TextWriter out) Enabled:
static void	synopsize(TextWriter out, String str) Enabled: Without initial newLine, but if anything's printed, with a final one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

OptMessageDescMaker

private static StaticMaker OptMessageDescMaker

myDocComment

private final String myDocComment

myVerb

private final String myVerb

myParams

private final ConstList myParams

myRetType

private Object myRetType

Constructor Detail

MessageDesc

public MessageDesc(String docComment,
                   String verb,
                   ConstList params,
                   Object retType)

Enabled: @param retType In order to avoid a circular dependency, this variable can hold a Class instead of a SlotGuard, in which case it will be converted to a SlotGuard as needed.

Method Detail

GetMessageDescMaker

public static StaticMaker GetMessageDescMaker()

Enabled:

synopsize

public static void synopsize(TextWriter out,
                             String str)
                      throws IOException

Enabled: Without initial newLine, but if anything's printed, with a final one.

IOException

getDocComment

public String getDocComment()

Enabled:

getVerb

public String getVerb()

Enabled:

getParams

public ConstList getParams()

Enabled:

getReturnType

public ValueGuard getReturnType()

Enabled:

__printOn

public void __printOn(TextWriter out)
               throws IOException

Enabled:

IOException

printHelpOn

public void printHelpOn(TextWriter out)
                 throws IOException

Enabled:

IOException

printDeclOn

private void printDeclOn(TextWriter out)
                  throws IOException

IOException