rocks.xmpp.extensions.disco.model.info

Class Identity

java.lang.Object

rocks.xmpp.extensions.disco.model.info.Identity

All Implemented Interfaces:

Comparable<Identity>

public final class Identity
extends Object
implements Comparable<Identity>

Represents an identity of an XMPP entity.

3. Discovering Information About a Jabber Entity

In disco, an entity's identity is broken down into its category (server, client, gateway, directory, etc.) and its particular type within that category (IM server, phone vs. handheld client, MSN gateway vs. AIM gateway, user directory vs. chatroom directory, etc.). This information helps requesting entities to determine the group or "bucket" of services into which the entity is most appropriately placed (e.g., perhaps the entity is shown in a GUI with an appropriate icon). An entity MAY have multiple identities. When multiple identity elements are provided, the name attributes for each identity element SHOULD have the same value.

This class is immutable.

Constructor Summary

Constructors

Constructor and Description
Identity(String category, String type) Creates an identity with a category and type.
Identity(String category, String type, String name) Creates an identity with a category, type and name.
Identity(String category, String type, String name, String language) Creates an identity with a category, type, name and language.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Identity o) Implements a natural ordering of an identity, as suggested and required by XEP-0115: Entity Capabilities.
boolean	equals(Object o) An identity is considered equal, if category, type and language are equal, because there cannot be two identities with the same category, type and language, but with different names.
String	getCategory() Gets the category, e.g. server, client, gateway, directory, etc.
String	getLanguage() The optional language to localize the name.
String	getName() Gets the identity's name.
String	getType() Gets the type within the category, e.g.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Identity

public Identity(String category,
                String type)

Creates an identity with a category and type.

Parameters:

category - The category.

type - The type.

Identity

public Identity(String category,
                String type,
                String name)

Creates an identity with a category, type and name.

Parameters:

category - The category.

type - The type.

name - The name.

Identity

public Identity(String category,
                String type,
                String name,
                String language)

Creates an identity with a category, type, name and language.

Parameters:

category - The category.

type - The type.

name - The name.

language - The language.

Method Detail

getCategory

public final String getCategory()

Gets the category, e.g. server, client, gateway, directory, etc.

Returns:

The category.

getType

public final String getType()

Gets the type within the category, e.g. IM server, phone vs. handheld client, MSN gateway vs. AIM gateway, user directory vs. chatroom directory, etc.

Returns:

The type.

getName

public final String getName()

Gets the identity's name.

Returns:

The name

getLanguage

public final String getLanguage()

The optional language to localize the name.

Returns:

The language.

equals

public final boolean equals(Object o)

An identity is considered equal, if category, type and language are equal, because there cannot be two identities with the same category, type and language, but with different names.

Overrides:

equals in class Object

Parameters:

o - The other object.

Returns:

True, if category, type and language are equal.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

compareTo

public final int compareTo(Identity o)

Implements a natural ordering of an identity, as suggested and required by XEP-0115: Entity Capabilities.

Specified by:

compareTo in interface Comparable<Identity>

Parameters:

o - The other identity.

Returns:

The result of the comparison.

toString

public final String toString()

Overrides:

toString in class Object