rocks.xmpp.core.stanza.model

Class StanzaError

java.lang.Object

rocks.xmpp.core.stanza.model.StanzaError

public final class StanzaError
extends Object

The implementation of a stanza's <error/> element.

See 8.3.2. Syntax

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StanzaError.Type Represents a <error/> 'type' attribute.

Constructor Summary

Constructors

Constructor and Description
StanzaError(Condition condition) Creates an error with a given condition.
StanzaError(Condition condition, String text) Creates an error with a given condition and text.
StanzaError(StanzaError.Type type, Condition condition) Creates an error with a given error type and a condition.
StanzaError(StanzaError.Type type, Condition condition, String text) Creates an error with a given error type and a condition.

Method Summary

Modifier and Type	Method and Description
Jid	getBy() Gets the 'by' attribute.
Condition	getCondition() Gets the defined error condition.
Object	getExtension() Gets the application specific condition, if any.
String	getLanguage() Gets the language of the error text.
String	getText() Gets the optional error text.
StanzaError.Type	getType() Gets the error type, either 'auth', 'cancel', 'continue', 'modify' or 'wait'.
void	setBy(Jid by) Sets the 'by' attribute.
void	setExtension(Object extension) Sets an application specific condition.
void	setText(String text) Sets the optional error text.
void	setText(String text, String language) Sets the optional error text and a language.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StanzaError

public StanzaError(StanzaError.Type type,
                   Condition condition)

Creates an error with a given error type and a condition.

The <error/> element MUST contain a defined condition element.

Parameters:

type - The error type.

condition - The condition.

StanzaError

public StanzaError(StanzaError.Type type,
                   Condition condition,
                   String text)

Creates an error with a given error type and a condition.

The <error/> element MUST contain a defined condition element.

Parameters:

type - The error type.

condition - The condition.

text - The text.

StanzaError

public StanzaError(Condition condition)

Creates an error with a given condition.

The error type is set by the condition's associated error type.

Parameters:

condition - The condition.

StanzaError

public StanzaError(Condition condition,
                   String text)

Creates an error with a given condition and text.

The error type is set by the condition's associated error type.

Parameters:

condition - The condition.

text - The text.

Method Detail

getBy

public Jid getBy()

Gets the 'by' attribute.

8.3.1. Rules

The entity that returns an error stanza MAY pass along its JID to the sender of the generated stanza (e.g., for diagnostic or tracking purposes) through the addition of a 'by' attribute to the <error/> child element.

Returns:

The JID.

See Also:

setBy(rocks.xmpp.core.Jid)

setBy

public void setBy(Jid by)

Sets the 'by' attribute.

Parameters:

by - The JID.

See Also:

getBy()

getType

public StanzaError.Type getType()

Gets the error type, either 'auth', 'cancel', 'continue', 'modify' or 'wait'.

Returns:

The type.

getText

public String getText()

Gets the optional error text.

Returns:

The text.

See Also:

setText(String)

setText

public void setText(String text)

Sets the optional error text.

Parameters:

text - The text.

See Also:

setText(String, String), getText()

setText

public void setText(String text,
                    String language)

Sets the optional error text and a language.

Parameters:

text - The text.

language - The language.

See Also:

setText(String), getText()

getLanguage

public String getLanguage()

Gets the language of the error text.

Returns:

The language.

See Also:

setText(String, String)

getExtension

public Object getExtension()

Gets the application specific condition, if any.

8.3.4. Application-Specific Conditions

As noted, an application MAY provide application-specific stanza error information by including a properly namespaced child within the error element. Typically, the application-specific element supplements or further qualifies a defined element. Thus, the <error/> element will contain two or three child elements.

Returns:

The application specific condition.

See Also:

setExtension(Object)

setExtension

public void setExtension(Object extension)

Sets an application specific condition.

Parameters:

extension - The application specific condition.

See Also:

getExtension()

getCondition

public Condition getCondition()

Gets the defined error condition.

Returns:

The error condition.

See Also:

8.3.3. Defined Conditions

toString

public String toString()

Overrides:

toString in class Object