ClassPathModelFinder (Apache OpenNLP :: API 3.0.0-M4 API)
Description: declaration: package: opennlp.tools.models, interface: ClassPathModelFinder

Package opennlp.tools.models

# Interface ClassPathModelFinder

public interface ClassPathModelFinder
Describes a scanner which detects OpenNLP specific model files in an applications's classpath. If compatible models are present at runtime, each discovered element is made available as `ClassPathModelEntry`.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `OPENNLP_MODEL_JAR_PREFIX`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Set<ClassPathModelEntry>`
  `findModels(boolean reloadCache)`
  Finds OpenNLP models available within an applications's classpath.

- ## Field Details

  - ### OPENNLP_MODEL_JAR_PREFIX

    static final String OPENNLP_MODEL_JAR_PREFIX
    See Also:
      - Constant Field Values

- ## Method Details

  - ### findModels

    Set<ClassPathModelEntry> findModels(boolean reloadCache)
    Finds OpenNLP models available within an applications's classpath.
    Parameters:
      `reloadCache` - `true`, if the internal cache should explicitly be reloaded, `false` otherwise.
    Returns:
      A `Set` of `model entries`. It might be empty, if none were found.