org.erights.e.elib.base
Class TypeDesc

java.lang.Object
  |
  +--org.erights.e.elib.slot.BaseGuard
        |
        +--org.erights.e.elib.slot.BaseAuditor
              |
              +--org.erights.e.elib.base.TypeDesc
All Implemented Interfaces:
Auditor, Guard, Marker, Persistent, Serializable, SlotGuard, ValueGuard
Direct Known Subclasses:
ClassDesc, ProtocolDesc

public class TypeDesc
extends BaseAuditor
implements Persistent

Untamed: A type description object, as would be created by an "implements" expression.

A TypeDesc describes the protocol that objects of that type respond to, and is used as a Guard to coerce a provided value into an instance of this type.

Author:
Mark S. Miller
See Also:
Serialized Form

Field Summary
private  ConstList myAuditors
           
private  String myDocComment
           
private  String myFQName
           
private  ConstMap myMTypes
           
(package private) static long serialVersionUID
           
 
Fields inherited from class org.erights.e.elib.slot.BaseGuard
myOptValueGuard
 
Fields inherited from interface org.erights.e.elib.serial.Persistent
HONORARY, HONORED_NAMES
 
Constructor Summary
TypeDesc(String docComment, String optFQName, ConstList auditors, ConstList mTypes)
          Enabled:
 
Method Summary
 ConstList getAuditors()
          Enabled:
 String getDocComment()
          Enabled:
 String getFQName()
          Enabled: Gets the fully qualified name
 ConstMap getMessageTypes()
          Enabled:
 String getName()
          Enabled: Gets the simple name.
 void prettyPrintOn(boolean fullFlag, TextWriter out)
          Enabled: Prints in the most expansive form accepted by "interface".
 String show()
          Enabled:
 String toString()
          Suppressed: Prints ``
 
Methods inherited from class org.erights.e.elib.slot.BaseAuditor
audit, coerce
 
Methods inherited from class org.erights.e.elib.slot.BaseGuard
__printOn, accepts, and, butNot, coerce, get, makeSlot, makeSlot, not, or, xor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID

myDocComment

private final String myDocComment

myFQName

private final String myFQName

myAuditors

private final ConstList myAuditors

myMTypes

private final ConstMap myMTypes
Constructor Detail

TypeDesc

public TypeDesc(String docComment,
                String optFQName,
                ConstList auditors,
                ConstList mTypes)
Enabled:

Method Detail

getDocComment

public String getDocComment()
Enabled:


getName

public String getName()
Enabled: Gets the simple name.

XXX should it be the flat name?

Specified by:
getName in interface SlotGuard
Overrides:
getName in class BaseGuard

getFQName

public String getFQName()
Enabled: Gets the fully qualified name


getAuditors

public ConstList getAuditors()
Enabled:


getMessageTypes

public ConstMap getMessageTypes()
Enabled:


toString

public String toString()
Suppressed: Prints ``

Overrides:
toString in class BaseGuard
Returns:
a string representation of the object.

prettyPrintOn

public void prettyPrintOn(boolean fullFlag,
                          TextWriter out)
                   throws IOException
Enabled: Prints in the most expansive form accepted by "interface".

fullFlag controls whether message names containing an '(' get printed too. These are for capturing Java signatures.

IOException

show

public String show()
Enabled:



comments?