Class NoOperation

  • All Implemented Interfaces:
    Completable, Streamable

    public class NoOperation
    extends AbstractAFPObject
    implements Completable
    The No Operation structured field may be used to carry comments or any other type of unarchitected data. Although not recommended, it may also be used to carry semantic data in private or exchange data streams. However, because receivers of interchange data streams should ignore the content of No Operation structured fields and because receiver-generator products are not required to propagate No Operation structured fields, no semantics should be attached to the data carried by the No Operation structured field in interchange
    • Field Detail

      • MAX_DATA_LEN

        private static final int MAX_DATA_LEN
        Up to 32759 bytes of data with no architectural definition
        See Also:
        Constant Field Values
      • content

        private java.lang.String content
        Byte representation of the comment
    • Constructor Detail

      • NoOperation

        public NoOperation​(java.lang.String content)
        Construct a tag logical element with the name and value specified.
        Parameters:
        content - the content to record
    • Method Detail

      • writeToStream

        public void writeToStream​(java.io.OutputStream os)
                           throws java.io.IOException
        Accessor method to obtain the byte array AFP datastream for the NoOperation.
        Specified by:
        writeToStream in interface Streamable
        Parameters:
        os - The outputsteam stream
        Throws:
        java.io.IOException - if an I/O exception occurs during processing
      • isComplete

        public boolean isComplete()
        Returns true if this object is complete
        Specified by:
        isComplete in interface Completable
        Returns:
        true if this object is complete
      • setComplete

        public void setComplete​(boolean complete)
        Sets whether or not this object is complete or not
        Specified by:
        setComplete in interface Completable
        Parameters:
        complete - true if this object is complete
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object