## Uses of Class
org.apache.uima.cas.SerialFormat

- Packages that use SerialFormat
  Package | Description
  --- | ---
  org.apache.uima.cas | Common Analysis System (CAS) Interfaces.
  org.apache.uima.cas.impl | Implementation and Low-Level API for the CAS Interfaces.
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- - ### Uses of SerialFormat in org.apache.uima.cas

    Methods in org.apache.uima.cas that return SerialFormat
    Modifier and Type | Method and Description
    --- | ---
    `static SerialFormat` | SerialFormat.`valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static SerialFormat[]` | SerialFormat.`values()` Returns an array containing the constants of this enum type, in the order they are declared.

  - ### Uses of SerialFormat in org.apache.uima.cas.impl

    Methods in org.apache.uima.cas.impl that return SerialFormat
    Modifier and Type | Method and Description
    --- | ---
    `static SerialFormat` | Serialization.`deserializeCAS(CAS cas, InputStream istream)` Deserialize a CAS, in various binary formats, into an existing CAS Note: this form supports deserializing the following binary representations: - plain (uncompressed) - compressed, no type filtering (form 4), Delta and not-delta - compressed, no type filtering (form 6), not-delta only.
    `SerialFormat` | CASImpl.`reinit(CommonSerDes.Header h, InputStream istream, CASMgrSerializer casMgrSerializer, CasLoadMode casLoadMode, BinaryCasSerDes6 f6, AllowPreexistingFS allowPreexistingFS, TypeSystemImpl ts)` --------------------------------------------------------------------- Deserialize a binary input stream, after reading the header, and optionally an externally provided type system and index spec used in compressed form 6 serialization previously This reads in and deserializes CAS data from a stream.
    `SerialFormat` | CASImpl.`reinit(InputStream istream)` --------------------------------------------------------------------- see Blob Format in CASSerializer This reads in and deserializes CAS data from a stream.

  - ### Uses of SerialFormat in org.apache.uima.util

    Methods in org.apache.uima.util that return SerialFormat
    Modifier and Type | Method and Description
    --- | ---
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, CAS aCAS)` Loads a Cas from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, CAS aCAS, TypeSystem typeSystem)` This load variant can be used for loading Form 6 compressed CASes where the type system to use to deserialize is provided as an argument.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS, boolean leniently)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(InputStream casInputStream, InputStream tsiInputStream, CAS aCAS, CasLoadMode casLoadMode)` Loads a CAS from an Input Stream.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, CAS aCAS)` Loads a Cas from a URL source.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, URL tsiUrl, CAS aCAS, boolean leniently)` Loads a CAS from a URL source.
    `static SerialFormat` | CasIOUtils.`load(URL casUrl, URL tsiUrl, CAS aCAS, CasLoadMode casLoadMode)` Loads a CAS from a URL source.

    Methods in org.apache.uima.util with parameters of type SerialFormat
    Modifier and Type | Method and Description
    --- | ---
    `static void` | CasIOUtils.`save(CAS aCas, OutputStream docOS, OutputStream tsiOS, SerialFormat format)` Write the CAS in the specified format.
    `static void` | CasIOUtils.`save(CAS aCas, OutputStream docOS, SerialFormat format)` Write the CAS in the specified format.

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.