Package org.apache.fop.afp.util
Class AFPResourceUtil
java.lang.Object
org.apache.fop.afp.util.AFPResourceUtil
TODO better docs
Utility for AFP resource handling
A utility class to read structured fields from a MO:DCA document. Each
component of a mixed object document is explicitly defined and delimited
in the data. This is accomplished through the use of MO:DCA data structures,
called structured fields. Structured fields are used to envelop document
components and to provide commands and information to applications using
the data. Structured fields may contain one or more parameters. Each
parameter provides one value from a set of values defined by the architecture.
MO:DCA structured fields consist of two parts: an introducer that identifies the length and type of the structured field, and data that provides the structured field's effect. The data is contained in a set of parameters, which can consist of other data structures and data elements. The maximum length of a structured field is 32767 bytes.
MO:DCA structured fields consist of two parts: an introducer that identifies the length and type of the structured field, and data that provides the structured field's effect. The data is contained in a set of parameters, which can consist of other data structures and data elements. The maximum length of a structured field is 32767 bytes.
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
copyNamedResource
(String name, InputStream in, OutputStream out) Copy a named resource to a givenOutputStream
.static void
copyResourceFile
(InputStream in, OutputStream out) Copy a complete resource file to a givenOutputStream
.static byte[]
getNext
(byte[] identifier, InputStream inputStream) Get the next structured field as identified by the identifier parameter (this must be a valid MO:DCA structured field).
-
Method Details
-
getNext
Get the next structured field as identified by the identifier parameter (this must be a valid MO:DCA structured field).- Parameters:
identifier
- the three byte identifierinputStream
- the inputStream- Returns:
- the next structured field or null when there are no more
- Throws:
IOException
- if an I/O exception occurred
-
copyResourceFile
Copy a complete resource file to a givenOutputStream
.- Parameters:
in
- external resource inputout
- output destination- Throws:
IOException
- if an I/O error occurs
-
copyNamedResource
public static void copyNamedResource(String name, InputStream in, OutputStream out) throws IOException Copy a named resource to a givenOutputStream
. The MO:DCA fields read from theInputStream
are scanned for the resource with the given name.- Parameters:
name
- name of structured fieldin
- external resource inputout
- output destination- Throws:
IOException
- if an I/O error occurs
-