Skip navigation links
cSpell Java
2018 Version

CSpell Java, 2018 Release
APIs Specification

This document is the API specification for the CSpell Java version, 2018 release.

See: Description

Packages 
Package Description
gov.nih.nlm.nls.cSpell.Api
This package provides Java APIs of CSpells - CSpellApi class.
gov.nih.nlm.nls.cSpell.Candidates
Provides Java classes to generate candidates of 1To1, Split, Merge corrections for non-words/real-words.
gov.nih.nlm.nls.cSpell.CmdLineSyntax
Provides Java classes necessary to create a command line interface tool.
gov.nih.nlm.nls.cSpell.Corrector
Provides Java classes to correct target token(s) with the best candidate found in 1To1, Split, Merge corrections for non-words/real-words.
gov.nih.nlm.nls.cSpell.Detector
Provides Java classes to detect a token for 1To1, Split, Merge corrections for non-words/real-words.
gov.nih.nlm.nls.cSpell.Dictionary
Contains Java classes of dictionaries used in CSpell.
gov.nih.nlm.nls.cSpell.Lib
Contains CSpell generic library classes of GlobalVars and Configuration.
gov.nih.nlm.nls.cSpell.NlpUtil
Contains fundamental natural language process (NLP) utility classes for CSpell.
gov.nih.nlm.nls.cSpell.Ranker
Provides Java classes to rank candidates and find the best candidate for 1To1, Split, Merge corrections for non-words/real-words.
gov.nih.nlm.nls.cSpell.Tools
Contains Java classes of CSpell command line tool.
gov.nih.nlm.nls.cSpell.Util
Contains CSpell utility classes for DebugPrint, DoubleVec, FileIo, Platform, etc.
This document is the API specification for the CSpell Java version, 2018 release. This API is packed in cSpell2018api.jar and cSpell2018dist.jar. There are 12 Java packages: The packages of gov.nih.nlm.nls.cSpell.Api is the most useful packages for users and should be paid more attention to. The other 11 packages are used as supporting packages for CSpell to work. End users may skip these 11 packages.
Skip navigation links
cSpell Java
2018 Version

Copyright © 2018 National Library of Medicine