Packageorg.igniterealtime.xiff.core
Classpublic class UnescapedJID
InheritanceUnescapedJID Inheritance AbstractJID Inheritance Object

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

See also

http://tools.ietf.org/html/rfc3920#section-3


Public Properties
 PropertyDefined By
 InheritedbareJID : String
[read-only] The JID without the resource.
AbstractJID
 Inheriteddomain : String
[read-only] The domain portion of the JID.
AbstractJID
  escaped : EscapedJID
[read-only] The unescaped JID in escaped form.
UnescapedJID
 Inheritednode : String
[read-only] The node portion of the JID.
AbstractJID
 Inheritedresource : String
[read-only] The resource portion of the JID.
AbstractJID
Protected Properties
 PropertyDefined By
 Inherited_domain : String
AbstractJID
 InheritedjidNodeValidator : RegExp
[static]
AbstractJID
 Inherited_node : String
AbstractJID
 Inherited_resource : String
AbstractJID
Public Methods
 MethodDefined By
  
UnescapedJID(inJID:String, validate:Boolean = false)
Creates a new UnescapedJID object.
UnescapedJID
  
equals(testJID:UnescapedJID, shouldTestBareJID:Boolean):Boolean
Determines if two unescaped JIDs are equivalent.
UnescapedJID
 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
escapedproperty
escaped:EscapedJID  [read-only]

The unescaped JID in escaped form.


Implementation
    public function get escaped():EscapedJID
Constructor Detail
UnescapedJID()Constructor
public function UnescapedJID(inJID:String, validate:Boolean = false)

Creates a new UnescapedJID 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:UnescapedJID, shouldTestBareJID:Boolean):Boolean

Determines if two unescaped JIDs are equivalent.

Parameters

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

Returns
Boolean — True if the JIDs are equivalent.