org.jivesoftware.smackx.time.packet

Class Time

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.time.packet.Time

public class Time
extends IQ

A Time IQ packet, which is used by XMPP clients to exchange their respective local times. Clients that wish to fully support the entity time protocol should register a PacketListener for incoming time requests that then respond with the local time.

See Also:

XEP-202

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
Time()
Time(Calendar cal) Creates a new Time instance using the specified calendar instance as the time value to send.

Method Summary

Methods

Modifier and Type	Method and Description
static Time	createResponse(Packet request)
String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
Date	getTime() Returns the local time or null if the time hasn't been set.
String	getTzo() Returns the time zone.
String	getUtc() Returns the time as a UTC formatted String using the format CCYY-MM-DDThh:mm:ssZ.
void	setTime(Date time) Sets the time using the local time.
void	setTzo(String tzo) Sets the time zone offset.
void	setUtc(String utc) Sets the time using UTC formatted String in the format CCYY-MM-DDThh:mm:ssZ.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Time

public Time()

Time

public Time(Calendar cal)

Creates a new Time instance using the specified calendar instance as the time value to send.

Parameters:

cal - the time value.

Method Detail

getTime

public Date getTime()

Returns the local time or null if the time hasn't been set.

Returns:

the local time.

setTime

public void setTime(Date time)

Sets the time using the local time.

Parameters:

time - the current local time.

getUtc

public String getUtc()

Returns the time as a UTC formatted String using the format CCYY-MM-DDThh:mm:ssZ.

Returns:

the time as a UTC formatted String.

setUtc

public void setUtc(String utc)

Sets the time using UTC formatted String in the format CCYY-MM-DDThh:mm:ssZ.

Parameters:

utc - the time using a formatted String.

getTzo

public String getTzo()

Returns the time zone.

Returns:

the time zone.

setTzo

public void setTzo(String tzo)

Sets the time zone offset.

Parameters:

tzo - the time zone offset.

createResponse

public static Time createResponse(Packet request)

getChildElementXML

public String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.