org.xmpp.packet
Class PacketError

java.lang.Object
  org.xmpp.packet.PacketError

@NotThreadSafe
public class PacketError
extends java.lang.Object

A packet error. Errors must have a type and condition. Optionally, they can include explanation text.

Author:

Matt Tucker

Nested Class Summary

static class	PacketError.Condition Type-safe enumeration for the error condition.
static class	PacketError.Type Error type.

Constructor Summary

PacketError(org.dom4j.Element element)
Constructs a new PacketError using an existing Element.

PacketError(PacketError.Condition condition)
Construcs a new PacketError with the specified condition.

PacketError(PacketError.Condition condition, PacketError.Type type)
Constructs a new PacketError with the specified condition and type.

PacketError(PacketError.Condition condition, PacketError.Type type, java.lang.String text)
Constructs a new PacketError.

PacketError(PacketError.Condition condition, PacketError.Type type, java.lang.String text, java.lang.String lang)
Constructs a new PacketError.

Method Summary

java.lang.String	getApplicationConditionName() Returns the name of the application-specific error condition, or null if there is no application-specific error.
java.lang.String	getApplicationConditionNamespaceURI() Returns the namespace of the application-specific error condition, or null if there is no application-specific error.
PacketError.Condition	getCondition() Returns the error condition.
org.dom4j.Element	getElement() Returns the DOM4J Element that backs the error.
java.lang.String	getText() Returns a text description of the error, or null if there is no text description.
java.lang.String	getTextLang() Returns the text description's language code, or null if there is no language code associated with the description text.
PacketError.Type	getType() Returns the error type.
void	setApplicationCondition(java.lang.String name) Sets an application-specific error condition.
void	setApplicationCondition(java.lang.String name, java.lang.String namespaceURI) Sets an application-specific error condition.
void	setCondition(PacketError.Condition condition) Sets the error condition.
void	setText(java.lang.String text) Sets the text description of the error.
void	setText(java.lang.String text, java.lang.String lang) Sets the text description of the error.
void	setType(PacketError.Type type) Sets the error type.
java.lang.String	toString()
java.lang.String	toXML() Returns the textual XML representation of this error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PacketError

public PacketError(PacketError.Condition condition)

Construcs a new PacketError with the specified condition. The error type will be set to the default for the specified condition.

Parameters:

condition - the error condition.

PacketError

public PacketError(PacketError.Condition condition,
                   PacketError.Type type)

Constructs a new PacketError with the specified condition and type.

Parameters:

condition - the error condition.

type - the error type.

PacketError

public PacketError(PacketError.Condition condition,
                   PacketError.Type type,
                   java.lang.String text)

Constructs a new PacketError.

Parameters:

type - the error type.

condition - the error condition.

text - the text description of the error.

PacketError

public PacketError(PacketError.Condition condition,
                   PacketError.Type type,
                   java.lang.String text,
                   java.lang.String lang)

Constructs a new PacketError.

Parameters:

type - the error type.

condition - the error condition.

text - the text description of the error.

lang - the language code of the error description (e.g. "en").

PacketError

public PacketError(org.dom4j.Element element)

Constructs a new PacketError using an existing Element. This is useful for parsing incoming error Elements into PacketError objects.

Parameters:

element - the error Element.

Method Detail

getType

public PacketError.Type getType()

Returns the error type.

Returns:

the error type.

See Also:

PacketError.Type

setType

public void setType(PacketError.Type type)

Sets the error type.

Parameters:

type - the error type.

See Also:

PacketError.Type

getCondition

public PacketError.Condition getCondition()

Returns the error condition.

Returns:

the error condition.

See Also:

PacketError.Condition

setCondition

public void setCondition(PacketError.Condition condition)

Sets the error condition.

Parameters:

condition - the error condition.

See Also:

PacketError.Condition

getText

public java.lang.String getText()

Returns a text description of the error, or null if there is no text description.

Returns:

the text description of the error.

setText

public void setText(java.lang.String text)

Sets the text description of the error.

Parameters:

text - the text description of the error.

setText

public void setText(java.lang.String text,
                    java.lang.String lang)

Sets the text description of the error. Optionally, a language code can be specified to indicate the language of the description.

Parameters:

text - the text description of the error.

lang - the language code of the description, or null to specify no language code.

getTextLang

public java.lang.String getTextLang()

Returns the text description's language code, or null if there is no language code associated with the description text.

Returns:

the language code of the text description, if it exists.

setApplicationCondition

public void setApplicationCondition(java.lang.String name)

Sets an application-specific error condition.

Parameters:

name - the name of the application-specific error condition.

setApplicationCondition

public void setApplicationCondition(java.lang.String name,
                                    java.lang.String namespaceURI)

Sets an application-specific error condition. Optionally, a application-specific namespace can be specified to define its own application-specific error .

Parameters:

name - the name of the application-specific error condition.

namespaceURI - the namespace of the application.

getApplicationConditionName

public java.lang.String getApplicationConditionName()

Returns the name of the application-specific error condition, or null if there is no application-specific error.

Returns:

the name of the application-specific error condition, if it exists.

getApplicationConditionNamespaceURI

public java.lang.String getApplicationConditionNamespaceURI()

Returns the namespace of the application-specific error condition, or null if there is no application-specific error.

Returns:

the namespace of the application-specific error condition, if it exists.

getElement

public org.dom4j.Element getElement()

Returns the DOM4J Element that backs the error. The element is the definitive representation of the error and can be manipulated directly to change error contents.

Returns:

the DOM4J Element.

toXML

public java.lang.String toXML()

Returns the textual XML representation of this error.

Returns:

the textual XML representation of this error.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object