org.erights.e.elang.interp
Class ProtocolDesc

java.lang.Object
  |
  +--org.erights.e.elib.slot.BaseGuard
        |
        +--org.erights.e.elib.slot.BaseAuditor
              |
              +--org.erights.e.elib.base.TypeDesc
                    |
                    +--org.erights.e.elang.interp.ProtocolDesc

All Implemented Interfaces:

Auditor, Guard, Marker, Persistent, Serializable, SlotGuard, ValueGuard

public class ProtocolDesc

extends TypeDesc

Safe: A type description object, as would be created by an interface expression.

A type so defined is used both as an audtitor, to check type conformance, and as a ValueGuard/SlotGuard to check that the value provided is an instance of an audited type.

See Also:

Serialized Form

Field Summary

static StaticMaker	ProtocolDescMaker Enabled:
(package private) static long	serialVersionUID

Fields inherited from class org.erights.e.elib.base.TypeDesc

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

ProtocolDesc(String docComment, String optFQName, ConstList auditors, ConstList mTypes)
Enabled: Makes a single type description object that can be used both as a rubber-stamping auditor and as a guard.

Method Summary

boolean

audit(Object script) Enabled: Used in a type's role as rubber-stamping auditor.

Methods inherited from class org.erights.e.elib.base.TypeDesc

getAuditors, getDocComment, getFQName, getMessageTypes, getName, prettyPrintOn, show, toString

Methods inherited from class org.erights.e.elib.slot.BaseAuditor

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

ProtocolDescMaker

public static final StaticMaker ProtocolDescMaker

Enabled:

Constructor Detail

ProtocolDesc

public ProtocolDesc(String docComment,
                    String optFQName,
                    ConstList auditors,
                    ConstList mTypes)

Enabled: Makes a single type description object that can be used both as a rubber-stamping auditor and as a guard.

This can be used for the object-equivalent of single-key authentication.

Method Detail

audit

public boolean audit(Object script)

Enabled: Used in a type's role as rubber-stamping auditor.

Specified by:

audit in interface Auditor

Overrides:

audit in class BaseAuditor