SentenceDetectorTool (Apache OpenNLP Tools 2.5.9 API)
Description: declaration: package: opennlp.tools.cmdline.sentdetect, class: SentenceDetectorTool

# Class SentenceDetectorTool

java.lang.Object
opennlp.tools.cmdline.CmdLineTool
opennlp.tools.cmdline.BasicCmdLineTool
opennlp.tools.cmdline.sentdetect.SentenceDetectorTool

public final class SentenceDetectorTool extends opennlp.tools.cmdline.BasicCmdLineTool
A sentence detector which uses a maxent model to predict the sentences.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SentenceDetectorTool()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getHelp()`
  `String`
  `getShortDescription()`
  `void`
  `run(String[] args)`
  Perform sentence detection on a stream of sentences.

  ### Methods inherited from class opennlp.tools.cmdline.CmdLineTool

  `getName, hasParams`

  ### Methods inherited from class Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### SentenceDetectorTool

    public SentenceDetectorTool()

- ## Method Details

  - ### getShortDescription

    public String getShortDescription()
    Overrides:
      `getShortDescription` in class `opennlp.tools.cmdline.CmdLineTool`
    Returns:
      Retrieves a short description of what the tool does

  - ### getHelp

    public String getHelp()
    Specified by:
      `getHelp` in class `opennlp.tools.cmdline.CmdLineTool`
    Returns:
      Retrieves a description on how to use the tool

  - ### run

    public void run(String[] args)
    Perform sentence detection on a stream of sentences.

    A newline will be treated as a paragraph boundary.

    Specified by:
      `run` in class `opennlp.tools.cmdline.BasicCmdLineTool`
    Parameters:
      `args` - arguments