rocks.xmpp.core.stanza.model.server

Class IQ

java.lang.Object

rocks.xmpp.core.stanza.model.Stanza

rocks.xmpp.core.stanza.model.AbstractIQ

rocks.xmpp.core.stanza.model.server.IQ

All Implemented Interfaces:

ServerStreamElement

public final class IQ
extends AbstractIQ
implements ServerStreamElement

The implementation of the <iq/> element for the server namespace ('jabber:server').

Nested Class Summary

Nested classes/interfaces inherited from class rocks.xmpp.core.stanza.model.AbstractIQ

AbstractIQ.Type

Constructor Summary

Constructors

Constructor and Description
IQ(AbstractIQ.Type type, Object extension) Creates an IQ stanza with the given type and extension.
IQ(AbstractIQ.Type type, Object extension, String id) Creates an IQ stanza with the given id, type and extension.
IQ(Jid to, AbstractIQ.Type type, Object extension) Creates an IQ stanza with the given receiver, type and extension.
IQ(Jid to, AbstractIQ.Type type, Object extension, String id) Creates an IQ stanza with the given receiver, id, type and extension.
IQ(Jid to, AbstractIQ.Type type, Object extension, String id, Jid from, String language, StanzaError error) Creates an IQ stanza with the given receiver, id, type, extension and error.

Method Summary

Modifier and Type	Method and Description
IQ	createError(Condition condition) Creates an error response for this stanza.
IQ	createError(StanzaError error) Creates an error response for this stanza.
IQ	createResult() Creates a result IQ stanza, i.e. it uses the same id as this IQ, sets the type to 'result' and switches the 'to' and 'from' attribute.
IQ	createResult(Object extension) Creates a result IQ stanza with a payload, i.e. it uses the same id as this IQ, sets the type to 'result' and switches the 'to' and 'from' attribute.
IQ	withFrom(Jid from) Creates a copy of this stanza and adds a from attribute to it.

Methods inherited from class rocks.xmpp.core.stanza.model.AbstractIQ

getExtension, getType, isRequest, isResponse, setExtension, toString

Methods inherited from class rocks.xmpp.core.stanza.model.Stanza

getError, getFrom, getId, getLanguage, getTo, setError, setFrom, setId, setLanguage, setTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IQ

public IQ(AbstractIQ.Type type,
          Object extension)

Creates an IQ stanza with the given type and extension. The id attribute will be generated randomly.

Parameters:

type - The type.

extension - The extension.

IQ

public IQ(AbstractIQ.Type type,
          Object extension,
          String id)

Creates an IQ stanza with the given id, type and extension.

Parameters:

type - The type.

extension - The extension.

id - The id.

IQ

public IQ(Jid to,
          AbstractIQ.Type type,
          Object extension)

Creates an IQ stanza with the given receiver, type and extension. The id attribute will be generated randomly.

Parameters:

to - The receiver.

type - The type.

extension - The extension.

IQ

public IQ(Jid to,
          AbstractIQ.Type type,
          Object extension,
          String id)

Creates an IQ stanza with the given receiver, id, type and extension.

Parameters:

to - The receiver.

type - The type.

extension - The extension.

id - The id.

IQ

public IQ(Jid to,
          AbstractIQ.Type type,
          Object extension,
          String id,
          Jid from,
          String language,
          StanzaError error)

Creates an IQ stanza with the given receiver, id, type, extension and error.

Parameters:

to - The receiver.

type - The type.

extension - The extension.

id - The id.

from - The sender.

language - The language.

error - The error.

Method Detail

createResult

public final IQ createResult()

Creates a result IQ stanza, i.e. it uses the same id as this IQ, sets the type to 'result' and switches the 'to' and 'from' attribute.

Returns:

The result IQ stanza.

createResult

public final IQ createResult(Object extension)

Creates a result IQ stanza with a payload, i.e. it uses the same id as this IQ, sets the type to 'result' and switches the 'to' and 'from' attribute.

Parameters:

extension - The extension.

Returns:

The result IQ stanza.

createError

public final IQ createError(StanzaError error)

Description copied from class: Stanza

Creates an error response for this stanza.

Specified by:

createError in class Stanza

Parameters:

error - The error which is appended to the stanza.

Returns:

The error response.

See Also:

Stanza.getError()

createError

public final IQ createError(Condition condition)

Description copied from class: Stanza

Creates an error response for this stanza.

Specified by:

createError in class Stanza

Parameters:

condition - The error condition which is appended to the stanza.

Returns:

The error response.

See Also:

Stanza.getError()

withFrom

public final IQ withFrom(Jid from)

Description copied from class: Stanza

Creates a copy of this stanza and adds a from attribute to it.

Specified by:

withFrom in class Stanza

Parameters:

from - The sender.

Returns:

A new stanza with a from attribute.