Package 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, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement, TimeView
public class Time extends IQ implements TimeView
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:

  • Field Details

  • Constructor Details

  • Method Details

    • getTime

      public Date getTime()
      Returns the local time or null if the time hasn't been set.
      Returns:
      the local time.

    • getUtc

      public String getUtc()
      Description copied from interface: TimeView
      Returns the time as a UTC formatted String using the format CCYY-MM-DDThh:mm:ssZ.
      Specified by:
      getUtc in interface TimeView
      Returns:
      the time as a UTC formatted String.

    • getTzo

      public String getTzo()
      Description copied from interface: TimeView
      Returns the time zone.
      Specified by:
      getTzo in interface TimeView
      Returns:
      the time zone.

    • 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.

    • builder

      public static TimeBuilder builder(XMPPConnection connection)

    • builder

      public static TimeBuilder builder(IqData iqData)

    • builder

      public static TimeBuilder builder(String stanzaId)

    • builder

      public static TimeBuilder builder(Time timeRequest, Calendar calendar)

    • builder

      public static TimeBuilder builder(Time timeRequest)