Package org.languagetool.rules
Class UppercaseSentenceStartRule
- java.lang.Object
-
- org.languagetool.rules.Rule
-
- org.languagetool.rules.TextLevelRule
-
- org.languagetool.rules.UppercaseSentenceStartRule
-
public class UppercaseSentenceStartRule extends TextLevelRule
Checks that a sentence starts with an uppercase letter.- Author:
- Daniel Naber
-
-
Constructor Summary
Constructors Constructor Description UppercaseSentenceStartRule(ResourceBundle messages, Language language)
Deprecated.useUppercaseSentenceStartRule(ResourceBundle, Language, IncorrectExample, CorrectExample)
instead (deprecated since 3.3)UppercaseSentenceStartRule(ResourceBundle messages, Language language, IncorrectExample incorrectExample, CorrectExample correctExample)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
A short description of the error this rule can detect, usually in the language of the text that is checked.String
getId()
A string used to identify the rule in e.g.protected boolean
isEMail(String token)
protected boolean
isUrl(String token)
RuleMatch[]
match(List<AnalyzedSentence> sentences)
int
minToCheckParagraph()
Gives back the minimum number of paragraphs to check to give back a correct result.-
Methods inherited from class org.languagetool.rules.TextLevelRule
estimateContextForSureMatch, match, match
-
Methods inherited from class org.languagetool.rules.Rule
addExamplePair, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice
-
-
-
-
Constructor Detail
-
UppercaseSentenceStartRule
public UppercaseSentenceStartRule(ResourceBundle messages, Language language, IncorrectExample incorrectExample, CorrectExample correctExample)
- Since:
- 3.3
-
UppercaseSentenceStartRule
public UppercaseSentenceStartRule(ResourceBundle messages, Language language)
Deprecated.useUppercaseSentenceStartRule(ResourceBundle, Language, IncorrectExample, CorrectExample)
instead (deprecated since 3.3)
-
-
Method Detail
-
getId
public final String getId()
Description copied from class:Rule
A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the charactersA-Z
and the underscore.
-
getDescription
public final String getDescription()
Description copied from class:Rule
A short description of the error this rule can detect, usually in the language of the text that is checked.- Specified by:
getDescription
in classRule
-
match
public RuleMatch[] match(List<AnalyzedSentence> sentences) throws IOException
- Specified by:
match
in classTextLevelRule
- Throws:
IOException
-
isUrl
protected boolean isUrl(String token)
-
isEMail
protected boolean isEMail(String token)
-
minToCheckParagraph
public int minToCheckParagraph()
Description copied from class:TextLevelRule
Gives back the minimum number of paragraphs to check to give back a correct result. Only used by LO office extension.- n == -1 --> need to check full text (use only if really needed / bad performance) examples: AbstractWordCoherencyRule, GenericUnpairedBracketsRule, ...
- n == 0 --> need only to check the current paragraph examples: MultipleWhitespaceRule, LongParagraphRule, ...
- n >= 1 --> need only to check n paragraphs around the current paragraph examples: ParagraphRepeatBeginningRule (n == 1), WordRepeatBeginningRule (n == 2), ...
- Specified by:
minToCheckParagraph
in classTextLevelRule
-
-