# Index

A C D E F G H L M O P S T
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

AbstractClassPathModelFinder - Class in opennlp.tools.models
  A base implementation of a `ClassPathModelFinder` for the detection of OpenNLP models in the classpath.
AbstractClassPathModelFinder() - Constructor for class opennlp.tools.models.AbstractClassPathModelFinder
  By default, it scans for `ClassPathModelFinder.OPENNLP_MODEL_JAR_PREFIX`.
AbstractClassPathModelFinder(String) - Constructor for class opennlp.tools.models.AbstractClassPathModelFinder

## C

ClassgraphModelFinder - Class in opennlp.tools.models.classgraph
  Enables the detection of OpenNLP models in the classpath via Classgraph.
ClassgraphModelFinder() - Constructor for class opennlp.tools.models.classgraph.ClassgraphModelFinder
  By default, it scans for "opennlp-models-*.jar".
ClassgraphModelFinder(String) - Constructor for class opennlp.tools.models.classgraph.ClassgraphModelFinder
ClassPathLoaderException - Exception in opennlp.tools.models
ClassPathLoaderException(String) - Constructor for exception opennlp.tools.models.ClassPathLoaderException
ClassPathLoaderException(String, Throwable) - Constructor for exception opennlp.tools.models.ClassPathLoaderException
ClassPathLoaderException(Throwable) - Constructor for exception opennlp.tools.models.ClassPathLoaderException
ClassPathModel - Record Class in opennlp.tools.models
  A record that holds the binary representation of an OpenNLP model and related properties.
ClassPathModel(Properties, byte[]) - Constructor for record class opennlp.tools.models.ClassPathModel
  Creates an instance of a `ClassPathModel` record class.
ClassPathModelEntry - Record Class in opennlp.tools.models
  Encapsulates a classpath entry that is associated with a `model URI` and optional `properties`.
ClassPathModelEntry(URI, Optional<URI>) - Constructor for record class opennlp.tools.models.ClassPathModelEntry
  Creates an instance of a `ClassPathModelEntry` record class.
ClassPathModelFinder - Interface in opennlp.tools.models
  Describes a scanner which detects OpenNLP specific model files in an applications's classpath.
ClassPathModelLoader - Class in opennlp.tools.models
  Responsible for loading OpenNLP models from the classpath via `entries`.
ClassPathModelLoader() - Constructor for class opennlp.tools.models.ClassPathModelLoader
ClassPathModelProvider - Interface in opennlp.tools.models
  A provider for obtaining pre-trained OpenNLP `models` from an application's classpath.

## D

DefaultClassPathModelProvider - Class in opennlp.tools.models
  A default implementation of `ClassPathModelProvider` which by default relies on `SimpleClassPathModelFinder` to scan for models in the current classpath.
DefaultClassPathModelProvider() - Constructor for class opennlp.tools.models.DefaultClassPathModelProvider
  Instantiates a `DefaultClassPathModelProvider` with a `SimpleClassPathModelFinder` and uses a default `ClassPathModelLoader`.
DefaultClassPathModelProvider(ClassPathModelFinder, ClassPathModelLoader) - Constructor for class opennlp.tools.models.DefaultClassPathModelProvider
  Instantiates a `DefaultClassPathModelProvider` with the specified `modelJarPattern`, a `model finder` and a `model loader` instance.
DirectoryModelFinder - Class in opennlp.tools.models.dir
  The `DirectoryModelFinder` class is responsible for finding model files in a given directory on the classpath.
DirectoryModelFinder(String, Path, boolean) - Constructor for class opennlp.tools.models.dir.DirectoryModelFinder
  Instantiates a new `DirectoryModelFinder` with the specified parameters.

## E

equals(Object) - Method in record class opennlp.tools.models.ClassPathModel
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class opennlp.tools.models.ClassPathModelEntry
  Indicates whether some other object is "equal to" this one.

## F

findModels(boolean) - Method in class opennlp.tools.models.AbstractClassPathModelFinder
findModels(boolean) - Method in interface opennlp.tools.models.ClassPathModelFinder
  Finds OpenNLP models available within an applications's classpath.

## G

getModelLanguage() - Method in record class opennlp.tools.models.ClassPathModel
getModelName() - Method in record class opennlp.tools.models.ClassPathModel
getModelSHA256() - Method in record class opennlp.tools.models.ClassPathModel
getModelVersion() - Method in record class opennlp.tools.models.ClassPathModel

## H

hashCode() - Method in record class opennlp.tools.models.ClassPathModel
  Returns a hash code value for this object.
hashCode() - Method in record class opennlp.tools.models.ClassPathModelEntry
  Returns a hash code value for this object.

## L

load(String, ModelType, Class<T>) - Method in interface opennlp.tools.models.ClassPathModelProvider
  Restores a `model` among all classpath models at runtime according to the specified parameters `lang` and `type`.
load(String, ModelType, Class<T>) - Method in class opennlp.tools.models.DefaultClassPathModelProvider
  Restores a `model` among all classpath models at runtime according to the specified parameters `lang` and `type`.
load(String, ModelType, Class<T>, boolean) - Method in interface opennlp.tools.models.ClassPathModelProvider
  Restores a `model` among all classpath models at runtime according to the specified parameters `lang` and `type`.
load(String, ModelType, Class<T>, boolean) - Method in class opennlp.tools.models.DefaultClassPathModelProvider
  Restores a `model` among all classpath models at runtime according to the specified parameters `lang` and `type`.
load(ClassPathModelEntry) - Method in class opennlp.tools.models.ClassPathModelLoader
  Loads a `ClassPathModel` from a `ClassPathModelEntry`

## M

model() - Method in record class opennlp.tools.models.ClassPathModel
  Returns the value of the `model` record component.
model() - Method in record class opennlp.tools.models.ClassPathModelEntry
  Returns the value of the `model` record component.

## O

OPENNLP_MODEL_JAR_PREFIX - Static variable in interface opennlp.tools.models.ClassPathModelFinder
opennlp.tools.models - package opennlp.tools.models
opennlp.tools.models.classgraph - package opennlp.tools.models.classgraph
opennlp.tools.models.dir - package opennlp.tools.models.dir
opennlp.tools.models.simple - package opennlp.tools.models.simple

## P

properties() - Method in record class opennlp.tools.models.ClassPathModel
  Returns the value of the `properties` record component.
properties() - Method in record class opennlp.tools.models.ClassPathModelEntry
  Returns the value of the `properties` record component.

## S

SimpleClassPathModelFinder - Class in opennlp.tools.models.simple
  Enables the detection of OpenNLP models in the classpath via JDK classes By default, this class will search for JAR files starting with "opennlp-models-*".
SimpleClassPathModelFinder() - Constructor for class opennlp.tools.models.simple.SimpleClassPathModelFinder
  By default, it scans for `ClassPathModelFinder.OPENNLP_MODEL_JAR_PREFIX`.
SimpleClassPathModelFinder(String) - Constructor for class opennlp.tools.models.simple.SimpleClassPathModelFinder

## T

toString() - Method in record class opennlp.tools.models.ClassPathModel
  Returns a string representation of this record class.
toString() - Method in record class opennlp.tools.models.ClassPathModelEntry
  Returns a string representation of this record class.

A C D E F G H L M O P S T
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form