public class DOFInterface extends java.lang.Object implements DOFImmutable, java.io.Serializable
DOFInterface.Builder
. This class is immutable once built.DOFObject
,
DOFObject.Provider
,
DOFInterface.Property
,
DOFInterface.Method
,
DOFInterface.Event
,
Exception
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
DOFInterface.Builder
Builder is used to build DOFInterfaces.
|
static class |
DOFInterface.Event
Defines an Event as part of a DOFInterface.
|
static class |
DOFInterface.Exception
Defines an Exception as part of a DOFInterface.
|
static class |
DOFInterface.Item
Defines Interface items.
|
static class |
DOFInterface.ItemType
Defines the different types of interface items: Property, Method, Event, Exception.
|
static class |
DOFInterface.Method
Defines a Method (or function) as part of a DOFInterface.
|
static class |
DOFInterface.Property
Defines a property as part of a DOFInterface.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Returns true if the interfaces are equivalent, meaning that OAP cannot
tell the difference between them.
|
byte[] |
getBytes()
Get the serialized form of the interface as a byte[].
|
DOFInterface.Event |
getEvent(int itemID)
Get an Event given its identifier.
|
java.util.List<DOFInterface.Event> |
getEvents()
Get the Events of this interface.
|
DOFInterface.Exception |
getException(int itemID)
Get an Exception given its identifier.
|
java.util.List<DOFInterface.Exception> |
getExceptions()
Get the Exceptions of this interface.
|
DOFInterfaceID |
getInterfaceID()
Get the interface ID.
|
DOFInterface.Method |
getMethod(int itemID)
Get a Method given its identifier.
|
java.util.List<DOFInterface.Method> |
getMethods()
Get the Methods of this interface.
|
java.util.List<DOFInterface.Property> |
getProperties()
Get the Properties of this interface.
|
DOFInterface.Property |
getProperty(int itemID)
Get a Property given its identifier.
|
int |
hashCode()
Compute hash code.
|
void |
marshal(DOFMarshalContext context,
java.lang.Object state,
DOFPacket p)
Marshal, or output a binary representation of this type, into the
specified packet.
|
java.lang.String |
toString()
Get a string representation of this object.
|
public DOFInterface.Property getProperty(int itemID)
itemID
- The Property's identifier.public DOFInterface.Method getMethod(int itemID)
itemID
- The Method's identifier.public DOFInterface.Event getEvent(int itemID)
itemID
- The Event's identifier.public DOFInterface.Exception getException(int itemID)
itemID
- The Exception's identifier.public java.util.List<DOFInterface.Property> getProperties()
public java.util.List<DOFInterface.Method> getMethods()
public java.util.List<DOFInterface.Event> getEvents()
public java.util.List<DOFInterface.Exception> getExceptions()
public byte[] getBytes()
public DOFInterfaceID getInterfaceID()
public void marshal(DOFMarshalContext context, java.lang.Object state, DOFPacket p) throws DOFMarshalException
context
- The context for this set of related types.state
- The state of the object. Not applicable to this class.p
- The packet to write the type to.DOFMarshalException
- If the type is not supported.public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the interface to be compared. Null will return false;public int hashCode()
hashCode
in class java.lang.Object