Package org.jivesoftware.smackx.time.packet

Class Time

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlLangElement
    public class Time
extends org.jivesoftware.smack.packet.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

        org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.ResponseType, org.jivesoftware.smack.packet.IQ.Type

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT  
      static java.lang.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 Description
      Time()  
      Time​(java.util.Calendar cal)
      Creates a new Time instance using the specified calendar instance as the time value to send.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Time createResponse​(org.jivesoftware.smack.packet.IQ request)  
      protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)  
      java.util.Date getTime()
      Returns the local time or null if the time hasn't been set.
      java.lang.String getTzo()
      Returns the time zone.
      java.lang.String getUtc()
      Returns the time as a UTC formatted String using the format CCYY-MM-DDThh:mm:ssZ.
      void setTime​(java.util.Date time)
      Sets the time using the local time.
      void setTzo​(java.lang.String tzo)
      Sets the time zone offset.
      void setUtc​(java.lang.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, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML

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

        addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.jivesoftware.smack.packet.Element

        toXML, toXML

      • Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

        getQName

      • Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

        getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

    • Constructor Detail

      • Time

        public Time()

      • Time

        public Time​(java.util.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 java.util.Date getTime()
        Returns the local time or null if the time hasn't been set.
        Returns:
        the local time.

      • setTime

        public void setTime​(java.util.Date time)
        Sets the time using the local time.
        Parameters:
        time - the current local time.

      • getUtc

        public java.lang.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​(java.lang.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 java.lang.String getTzo()
        Returns the time zone.
        Returns:
        the time zone.

      • setTzo

        public void setTzo​(java.lang.String tzo)
        Sets the time zone offset.
        Parameters:
        tzo - the time zone offset.

      • createResponse

        public static Time createResponse​(org.jivesoftware.smack.packet.IQ request)

      • getIQChildElementBuilder

        protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder buf)
        Specified by:
        getIQChildElementBuilder in class org.jivesoftware.smack.packet.IQ