org.jivesoftware.smackx.time.packet

Class Time

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.time.packet.Time

All Implemented Interfaces:

Element, TopLevelStreamElement

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.IQChildElementXmlStringBuilder, 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.IQ

IQ_ELEMENT, QUERY_ELEMENT

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

DEFAULT_LANGUAGE, ITEM, language, TEXT

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

Modifier and Type	Method and Description
static Time	createResponse(IQ request)
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
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, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getChildElementXML, getType, initializeAsResultFor, initialzeAsResultFor, isRequestIQ, setType, toString, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setFrom, setLanguage, setPacketID, setStanzaId, setStanzaId, setTo, setTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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(IQ request)

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.