# Package org.apache.uima.util

Utility classes and interfaces used by UIMA components.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  AutoCloseableNoException | protectIndexes returns instances of this, rather than AutoCloseable, to permit users to use try with resources without a catch for Exception.
  CasPoolManagement | Management interface to a `CasPool`.
  InstrumentationFacility | The `InstrumentationFacility` interface defines a standard way for UIMA components to be instrumented for performance evaluation.
  IteratorNvc<E> | An Iterator with an extra method nextNvc, which skips the validity check
  Logger | A `Logger` is a component used to log messages.
  ProcessTrace | A `ProcessTrace` object keeps a record of events that have occurred and information, such as timing, about those events.
  ProcessTraceEvent | Captures information, including timing, about an event that occurred during processing.
  Progress | Progress statistics for a process.
  SaxDeserializer | Deserializes an `XMLizable` object from SAX events.
  Settings | A `Settings` object holds the properties used for external parameter overrides.
  TCasFormatter | Interface for components that generate a String representation of a CAS.
  UimaTimer | Interface for a timer, used to collect performance statistics for UIMA components.
  XMLizable | An interface to be implemented by UIMA classes that can be written to and parsed from XML.
  XMLParser | A UIMA `XMLParser` parses XML documents and generates UIMA components represented by the XML.

- Class Summary
  Class | Description
  --- | ---
  AnalysisEnginePerformanceReports | A class that is useful for generating an Analysis Engine performance report from a `ProcessTrace` object.
  AnalysisEngineUtils | Static utility methods relating to analysis engines.
  CasCopier | Utility class for doing deep copies of FeatureStructures from one CAS to another.
  CasCreationUtils | Utilities for creating and setting up CASes.
  CasIOUtils | A collection of static methods aimed at making it easy to
  CasPool | This class represents a simple pool of `CAS` instances.
  CasToInlineXml | Generates an *approximate* inline XML representation of a CAS.
  ConcurrentHashMapWithProducer<K,V> | A concurrent map supporting a value-creating get.
  ConsumerCasUtils |
  FileUtils | Some utilities for handling files.
  IntEntry<T> | like Entry<k, v> except the k is an int.
  JCasPool | This class represents a simple pool of `JCas` instances.
  Level | Provides the message level constants for logging and tracing
  LoggerPrintStream | A PrintStream implementation that writes to a UIMA logger.
  MessageReport |
  Misc |
  NameClassPair | A class that stores the name of an attribute and the Class of that attribute's value.
  ProgressImpl |
  SimpleResourceFactory | A simple implementation of a `ResourceFactory`.
  TCasToInlineXml | Deprecated As of v2.0, use `CasToInlineXml` instead.
  TypeSystemUtil |
  UriUtils | Static methods supporting proper handling of URIs
  XmlCasDeserializer | Deserializes a CAS from a standoff-XML format.
  XmlCasSerializer | Serializes a CAS to inline XML format.
  XMLInputSource | An input source used by the `XMLParser` to read XML documents for parsing.
  XMLParser.ParsingOptions | Option settings for the parser.
  XMLSerializer | Utility class that generates XML output from SAX events or DOM nodes.

- Enum Summary
  Enum | Description
  --- | ---
  CasLoadMode | Used with CasIOUtils, maybe elsewhere, to indicate how CASes are to be loaded or saved.

- Exception Summary
  Exception | Description
  --- | ---
  InvalidXMLException | Thrown by the `XMLParser` to indicate that an XML document is invalid or does not specify a valid object of the desired class.

## Package org.apache.uima.util Description

Utility classes and interfaces used by UIMA components.

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