Class MamFinIQ

    • Constructor Detail

      • MamFinIQ

        public MamFinIQ​(MamVersion version,
                        String queryId,
                        RSMSet rsmSet,
                        boolean complete,
                        boolean stable)
        MamFinIQ constructor.
        Parameters:
        version - TODO javadoc me please
        queryId - TODO javadoc me please
        rsmSet - TODO javadoc me please
        complete - TODO javadoc me please
        stable - TODO javadoc me please
    • Method Detail

      • isComplete

        public boolean isComplete()
        Return if it is complete.
        Returns:
        true if it is complete
      • isStable

        public boolean isStable()
        Return if it is stable.
        Returns:
        true if it is stable
      • getQueryId

        public final String getQueryId()
        Get query id.
        Returns:
        the query id
      • getIQChildElementBuilder

        protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder​(IQ.IQChildElementXmlStringBuilder xml)
        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:
        xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.
        Returns:
        the build to create the IQ child content.