org.ccnx.ccn.profiles.ccnd.FaceManager.FaceInstance Class Reference

List of all members.

Public Member Functions

 FaceInstance (ActionType action, PublisherPublicKeyDigest ccndID, NetworkProtocol ipProto, String host, Integer port)
 FaceInstance (ActionType action, PublisherPublicKeyDigest ccndID, Integer faceID)
 FaceInstance (ActionType action, PublisherPublicKeyDigest ccndID, NetworkProtocol ipProto, String host, Integer port, String multicastInterface, Integer multicastTTL, Integer lifetime)
 FaceInstance (byte[] raw)
Integer faceID ()
void setFaceID (Integer faceID)
String action ()
String toFormattedString ()
boolean validateAction (String action)
void decode (XMLDecoder decoder) throws ContentDecodingException
 Used by NetworkObject to decode the object from a network stream.
void encode (XMLEncoder encoder) throws ContentEncodingException
 Used by NetworkObject to encode the object to a network stream.
long getElementLabel ()
 Allow the encoder/decoder to retrieve the top-level element name programmatically.
boolean validate ()
 Make sure all of the necessary fields are filled in prior to attempting to encode.
int hashCode ()
boolean equals (Object obj)

Protected Attributes

String _action
 From the XML definitions: <xs:element name="Action" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="PublisherPublicKeyDigest" type="DigestType" minOccurs="0" maxOccurs="1"/> <xs:element name="FaceID" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/> <xs:element name="IPProto" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/> <xs:element name="Host" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="Port" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/> <xs:element name="MulticastInterface" type="xs:string" minOccurs="0" maxOccurs="1"/> <xs:element name="MulticastTTL" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/> <xs:element name="FreshnessSeconds" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
PublisherPublicKeyDigest _ccndID
Integer _faceID
NetworkProtocol _ipProto
String _host
Integer _port
String _multicastInterface
Integer _multicastTTL
Integer _lifetime

Member Function Documentation

void org.ccnx.ccn.profiles.ccnd.FaceManager.FaceInstance.decode ( XMLDecoder  decoder  )  throws ContentDecodingException [virtual]

Used by NetworkObject to decode the object from a network stream.

See also:
org.ccnx.ccn.impl.encoding.XMLEncodable

Implements org.ccnx.ccn.impl.encoding.GenericXMLEncodable.

void org.ccnx.ccn.profiles.ccnd.FaceManager.FaceInstance.encode ( XMLEncoder  encoder  )  throws ContentEncodingException [virtual]

Used by NetworkObject to encode the object to a network stream.

See also:
org.ccnx.ccn.impl.encoding.XMLEncodable

Implements org.ccnx.ccn.impl.encoding.GenericXMLEncodable.

long org.ccnx.ccn.profiles.ccnd.FaceManager.FaceInstance.getElementLabel (  )  [virtual]

Allow the encoder/decoder to retrieve the top-level element name programmatically.

This allows subclasses to rename elements without changing their encoder/decoders.

Returns:
the element label to use, as a key in a loaded encoding dictionary

Implements org.ccnx.ccn.impl.encoding.GenericXMLEncodable.

boolean org.ccnx.ccn.profiles.ccnd.FaceManager.FaceInstance.validate (  )  [virtual]

Make sure all of the necessary fields are filled in prior to attempting to encode.

All implementations of encode(XMLEncoder) should call this for their classes prior to encoding.

Returns:
true if object is valid and can be encoded, false if there is a problem; for example mandatory fields are uninitialized

Implements org.ccnx.ccn.impl.encoding.GenericXMLEncodable.


The documentation for this class was generated from the following file:
Generated on Fri May 13 16:27:47 2011 for Content-Centric Networking in Java by  doxygen 1.6.3