Package org.apache.fop.afp.modca
Class NoOperation
- java.lang.Object
-
- org.apache.fop.afp.modca.AbstractAFPObject
-
- org.apache.fop.afp.modca.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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
content
Byte representation of the commentprivate static int
MAX_DATA_LEN
Up to 32759 bytes of data with no architectural definition-
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
-
Constructor Summary
Constructors Constructor Description NoOperation(java.lang.String content)
Construct a tag logical element with the name and value specified.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isComplete()
Returns true if this object is completevoid
setComplete(boolean complete)
Sets whether or not this object is complete or notjava.lang.String
toString()
void
writeToStream(java.io.OutputStream os)
Accessor method to obtain the byte array AFP datastream for the NoOperation.-
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, copySF, truncate, writeChunksToStream, writeObjects
-
-
-
-
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
-
-
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 interfaceStreamable
- 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 interfaceCompletable
- 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 interfaceCompletable
- Parameters:
complete
- true if this object is complete
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-