Packageorg.igniterealtime.xiff.core
Classpublic class EscapedJID
InheritanceEscapedJID Inheritance AbstractJID

This class provides access to a JID (Jabber ID) in escaped form.

See also

http://xmpp.org/extensions/xep-0106.html


Public Properties
 PropertyDefined by
 InheritedbareJID : String
The JID without the resource.
AbstractJID
 Inheriteddomain : String
The domain portion of the JID.
AbstractJID
 Inheritednode : String
The node portion of the JID.
AbstractJID
 Inheritedresource : String
The resource portion of the JID.
AbstractJID
  unescaped : UnescapedJID
[read-only] The escaped JID in unescaped form.
EscapedJID
Protected Properties
 PropertyDefined by
 Inherited_domain : String = ""
AbstractJID
 InheritedjidNodeValidator : RegExp
[static]
AbstractJID
 Inherited_node : String = ""
AbstractJID
 Inherited_resource : String = ""
AbstractJID
Public Methods
 MethodDefined by
  
EscapedJID(inJID:String, validate:Boolean = false)
Creates a new EscapedJID object.
EscapedJID
  
equals(testJID:EscapedJID, shouldTestBareJID:Boolean):Boolean
Determines if two escaped JIDs are equivalent.
EscapedJID
 Inherited
escapedNode(n:String):String
[static] Provides functionality to convert a JID to an escaped format.
AbstractJID
 Inherited
toString():String
Converts JID represented by this class to a String.
AbstractJID
 Inherited
unescapedNode(n:String):String
[static] Provides functionality to return an escaped JID into a normal String.
AbstractJID
Property detail
unescapedproperty
unescaped:UnescapedJID  [read-only]

The escaped JID in unescaped form.

Implementation
    public function get unescaped():UnescapedJID
Constructor detail
EscapedJID()constructor
public function EscapedJID(inJID:String, validate:Boolean = false)

Creates a new EscapedJID object.

Parameters
inJID:String — The JID in String form.
 
validate:Boolean (default = false) — Will validate the JID string if true. Invalid JIDs will throw an error.
Method detail
equals()method
public function equals(testJID:EscapedJID, shouldTestBareJID:Boolean):Boolean

Determines if two escaped JIDs are equivalent.

Parameters
testJID:EscapedJID — The JID with which to test equivalency.
 
shouldTestBareJID:Boolean

Returns
Boolean — True if the JIDs are equivalent.