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').

Author:

Christian Schudt

Nested Class Summary

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

AbstractIQ.Type

Field Summary

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

from, id, language, to

Constructor Summary

Constructors

Constructor and Description
IQ(AbstractIQ.Type type) Creates an IQ stanza with the given type.
IQ(AbstractIQ.Type type, Object extension) Creates an IQ stanza with the given 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, String id, AbstractIQ.Type type, Object extension) Creates an IQ stanza with the given receiver, id, type and extension.
IQ(String id, AbstractIQ.Type type) Creates an IQ stanza with the given id and type.
IQ(String id, AbstractIQ.Type type, Object extension) Creates an IQ stanza with the given id, type and extension.

Method Summary

Modifier and Type	Method and Description
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.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IQ

public IQ(AbstractIQ.Type type)

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

Parameters:

type - The type.

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(String id,
          AbstractIQ.Type type)

Creates an IQ stanza with the given id and type. Not that, if the type is AbstractIQ.Type.SET or AbstractIQ.Type.GET, you will have to also set an extension.

Parameters:

id - The id.

type - The type.

IQ

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

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

Parameters:

id - The id.

type - The type.

extension - The extension.

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,
          String id,
          AbstractIQ.Type type,
          Object extension)

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

Parameters:

to - The receiver.

id - The id.

type - The type.

extension - The extension.

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.

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(), Stanza.createError(Stanza, StanzaError)