A B C D E F G H I J K L M N O P Q R S T U V W X

A

addAttribute(String, String) - Method in class cc.redpen.config.ValidatorConfiguration

Add an attribute.

addAttribute(String, boolean) - Method in class cc.redpen.config.ValidatorConfiguration

Add an attribute.

addElement(TokenElement) - Method in class cc.redpen.validator.ExpressionRule

addError(String, Sentence) - Method in class cc.redpen.validator.JavaScriptValidator

addError(String, Sentence) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with specified message

addErrorWithPosition(String, Sentence, int, int) - Method in class cc.redpen.validator.JavaScriptValidator

addErrorWithPosition(String, Sentence, int, int) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with specified message

addLink(String) - Method in class cc.redpen.model.Sentence

Add a link to Sentence

addListBlock() - Method in class cc.redpen.model.Document.DocumentBuilder

Add a new list block.

addListElement(int, List<Sentence>) - Method in class cc.redpen.model.Document.DocumentBuilder

Add list element to the last list block.

addListElement(int, String) - Method in class cc.redpen.model.Document.DocumentBuilder

Add list element to the last list block.

addLocalizedError(Sentence, Object...) - Method in class cc.redpen.validator.JavaScriptValidator

addLocalizedError(String, Sentence, Object...) - Method in class cc.redpen.validator.JavaScriptValidator

addLocalizedError(Sentence, Object...) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with localized default error message

addLocalizedError(String, Sentence, Object...) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with localized message with specified message key

addLocalizedErrorFromToken(Sentence, TokenElement) - Method in class cc.redpen.validator.JavaScriptValidator

addLocalizedErrorFromToken(Sentence, TokenElement) - Method in class cc.redpen.validator.Validator

create a ValidationError using the details within the given token & localized message

addLocalizedErrorWithPosition(Sentence, int, int, Object...) - Method in class cc.redpen.validator.JavaScriptValidator

addLocalizedErrorWithPosition(Sentence, int, int, Object...) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with default localized error message

addLocalizedErrorWithPosition(String, Sentence, int, int, Object...) - Method in class cc.redpen.validator.Validator

create a ValidationError for the specified position with specified message key

addParagraph() - Method in class cc.redpen.model.Document.DocumentBuilder

Add paragraph to document.

addSection(int, List<Sentence>) - Method in class cc.redpen.model.Document.DocumentBuilder

Add a section to the document.

addSection(int) - Method in class cc.redpen.model.Document.DocumentBuilder

Add a section without header content.

addSectionHeader(String) - Method in class cc.redpen.model.Document.DocumentBuilder

Add section header content to the last section.

addSentence(Sentence) - Method in class cc.redpen.model.Document.DocumentBuilder

Add a sentence.

addSentence(String, int) - Method in class cc.redpen.model.Document.DocumentBuilder

Add sentence to document.

addSentence(LineOffset, String, SentenceExtractor, Document.DocumentBuilder) - Static method in class cc.redpen.parser.PlainTextParser

addSentence(LineOffset, String, String, SentenceExtractor, List<Sentence>) - Method in class org.asciidoctor.RedPenTreeProcessor

Add a processed AsciiDoc sentence, using the raw source sentence to guide the character offsets.

addSymbol(Symbol) - Method in class cc.redpen.config.Configuration.ConfigurationBuilder

addValidationError(Sentence, Object...) - Method in class cc.redpen.validator.Validator

Deprecated.

use Validator.addLocalizedError(Sentence, Object...) instead

addValidationError(String, Sentence, Object...) - Method in class cc.redpen.validator.Validator

Deprecated.

use Validator.addLocalizedError(String, Sentence, Object...) instead

addValidationErrorFromToken(Sentence, TokenElement) - Method in class cc.redpen.validator.Validator

Deprecated.

use Validator.addLocalizedErrorFromToken(Sentence, TokenElement) instead

addValidationErrorWithPosition(Sentence, Optional<LineOffset>, Optional<LineOffset>, Object...) - Method in class cc.redpen.validator.Validator

Deprecated.

use Validator.addLocalizedErrorWithPosition(Sentence, int, int, Object...) instead

addValidationErrorWithPosition(String, Sentence, Optional<LineOffset>, Optional<LineOffset>, Object...) - Method in class cc.redpen.validator.Validator

Deprecated.

use Validator.addLocalizedErrorWithPosition(String, Sentence, int, int, Object...) instead

addValidatorConfig(ValidatorConfiguration) - Method in class cc.redpen.config.Configuration.ConfigurationBuilder

appendElement(int, List<Sentence>) - Method in class cc.redpen.model.ListBlock

Append ListElement.

appendListBlock() - Method in class cc.redpen.model.Section

Append List.

appendListElement(int, List<Sentence>) - Method in class cc.redpen.model.Section

Append List element.

appendParagraph(Paragraph) - Method in class cc.redpen.model.Section

Add a paragraph.

appendSection(Section) - Method in class cc.redpen.model.Document.DocumentBuilder

Add a section.

appendSentence(String, int) - Method in class cc.redpen.model.Paragraph

Append a sentence to a paragraph.

appendSentence(Sentence) - Method in class cc.redpen.model.Paragraph

Append a sentence.

appendSubSection(Section) - Method in class cc.redpen.model.Section

Add a subsection.

ASCIIDOC - Static variable in interface cc.redpen.parser.DocumentParser

AsciiDocParser - Class in cc.redpen.parser

Parser for AsciiDoc format, utilizing AsciiDoctorJ.

AsciiDoc's syntax and grammar is documented at @see http://asciidoc.org/

AsciiDocParser() - Constructor for class cc.redpen.parser.AsciiDocParser

asJSON(ValidationError) - Method in class cc.redpen.formatter.JSONBySentenceFormatter

Render a single redpen error as JSON

asJSON(Document, List<ValidationError>) - Method in class cc.redpen.formatter.JSONBySentenceFormatter

Render as a JSON object a list of errors for a given document

asJSON(ValidationError) - Method in class cc.redpen.formatter.JSONFormatter

Render a single redpen error as JSON

asJSON(LineOffset) - Method in class cc.redpen.formatter.JSONFormatter

Render a line offset as JSON

asJSON(LineOffset, LineOffset) - Method in class cc.redpen.formatter.JSONFormatter

Render a start and end line offset as a 'position'

asJSON(int, int, int, int) - Method in class cc.redpen.formatter.JSONFormatter

Render a start and end coordinates as a 'position'

asJSON(Sentence, LineOffset, LineOffset) - Method in class cc.redpen.formatter.JSONFormatter

Render a start and end line offsets (ie: source text coordinates) as a description of a section of the sentence.getContent() string

asJSON(Document, List<ValidationError>) - Method in class cc.redpen.formatter.JSONFormatter

Render as a JSON object a list of errors for a given document

asTextile() - Method in class cc.redpen.parser.latex.Token

asVerbatim() - Method in class cc.redpen.parser.latex.Token

B

BaseDocumentParser - Class in cc.redpen.parser

Abstract Parser class containing common procedures to implements the concrete Parser classes.

BaseDocumentParser() - Constructor for class cc.redpen.parser.BaseDocumentParser

BLANK_LINE - Static variable in class cc.redpen.parser.latex.Token

BlockAccessor(Object) - Constructor for class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

This method takes an AsciiDoctorJ JRuby object which should be an instance of an abstract block.

build() - Method in class cc.redpen.config.Configuration.ConfigurationBuilder

build() - Method in class cc.redpen.model.Document.DocumentBuilder

BY_SENTENCE_COMPARATOR - Static variable in class cc.redpen.formatter.JSONBySentenceFormatter

Reusable comparator to compare errors by their position in the document, starting with the line number, followed by the offset within the line, and finally the sentence content

C

CandidateSentence - Class in cc.redpen.parser.markdown

Buffer list of to candidate content.

CandidateSentence(int, String, String) - Constructor for class cc.redpen.parser.markdown.CandidateSentence

CandidateSentence(int, String, String, int) - Constructor for class cc.redpen.parser.markdown.CandidateSentence

cc.redpen - package cc.redpen

contains RedPen Main class and some important classes used thought the project.

cc.redpen.config - package cc.redpen.config

Configuration and SymbolTable are provided.

cc.redpen.formatter - package cc.redpen.formatter

Formatter and the implementations are provided.

cc.redpen.model - package cc.redpen.model

Elements of Documents such as List, Sentence are provided.

cc.redpen.parser - package cc.redpen.parser

Parser and the implementations are provided.

cc.redpen.parser.latex - package cc.redpen.parser.latex

cc.redpen.parser.markdown - package cc.redpen.parser.markdown

Markdown Parser are provided.

cc.redpen.tokenizer - package cc.redpen.tokenizer

Provides tokenizers for each languages.

cc.redpen.util - package cc.redpen.util

Utility classes are provided.

cc.redpen.validator - package cc.redpen.validator

Validators and the factory classes are provided.

cc.redpen.validator.section - package cc.redpen.validator.section

SectionValidators are provided.

cc.redpen.validator.sentence - package cc.redpen.validator.sentence

SentenceValidators are provided.

col - Variable in class cc.redpen.parser.latex.Position

CommaNumberValidator - Class in cc.redpen.validator.sentence

Validate the number of commas in one sentence.

CommaNumberValidator() - Constructor for class cc.redpen.validator.sentence.CommaNumberValidator

compareTo(Object) - Method in class cc.redpen.parser.LineOffset

Configuration - Class in cc.redpen.config

Contains Settings used throughout RedPen.

Configuration.ConfigurationBuilder - Class in cc.redpen.config

Builder class of Configuration.

ConfigurationBuilder() - Constructor for class cc.redpen.config.Configuration.ConfigurationBuilder

ConfigurationLoader - Class in cc.redpen

Load the central configuration of RedPen.

ConfigurationLoader() - Constructor for class cc.redpen.ConfigurationLoader

containsSymbolByValue(char) - Method in class cc.redpen.config.SymbolTable

Detect the specified character is exit in the dictionary.

ContractionValidator - Class in cc.redpen.validator.sentence

Validate English contraction in the input document.

ContractionValidator() - Constructor for class cc.redpen.validator.sentence.ContractionValidator

createReader(InputStream) - Method in class cc.redpen.parser.BaseDocumentParser

create BufferedReader from InputStream is.

D

DEFAULT_DELETION_COST - Static variable in class cc.redpen.util.LevenshteinDistance

A constant holding the default deletion cost.

DEFAULT_INSERTION_COST - Static variable in class cc.redpen.util.LevenshteinDistance

A constant holding the default insertion cost.

DEFAULT_JS_VALIDATORS_PATH - Variable in class cc.redpen.validator.JavaScriptValidator

DEFAULT_MAX_LENGTH - Static variable in class cc.redpen.validator.sentence.SentenceLengthValidator

Default maximum length of sentences.

DEFAULT_MAX_PARAGRAPHS_IN_A_SECTION - Static variable in class cc.redpen.validator.section.ParagraphNumberValidator

Default maximum number of paragraphs in a section.

DEFAULT_MAXIMUM_WORDS_IN_A_SENTENCE - Static variable in class cc.redpen.validator.sentence.WordNumberValidator

Default maximum number of words in one sentence.

DEFAULT_PARAGRAPH_START_WITH - Static variable in class cc.redpen.validator.section.ParagraphStartWithValidator

Default matter paragraph start with.

DEFAULT_SIMILARITY_THRESHOLD - Static variable in class cc.redpen.validator.section.DuplicatedSectionValidator

Default threshold (Cosine similarity).

DEFAULT_SUBSTITUTION_COST - Static variable in class cc.redpen.util.LevenshteinDistance

A constant holding the default substitution cost.

DictionaryLoader<E> - Class in cc.redpen.util

load dictionary data from input source

DictionaryLoader(Supplier<E>, BiConsumer<E, String>) - Constructor for class cc.redpen.util.DictionaryLoader

Document - Class in cc.redpen.model

Document represents a file with many elements such as sentences, lists and headers.

Document(List<Section>, Optional<String>) - Constructor for class cc.redpen.model.Document

Constructor.

Document.DocumentBuilder - Class in cc.redpen.model

DocumentBuilder() - Constructor for class cc.redpen.model.Document.DocumentBuilder

Constructor.

DocumentBuilder(RedPenTokenizer) - Constructor for class cc.redpen.model.Document.DocumentBuilder

Constructor.

DocumentParser - Interface in cc.redpen.parser

DocumentParser generates Document from input.

DoubledJoshiValidator - Class in cc.redpen.validator.sentence

DoubledJoshiValidator checks if the input texts has duplicated Kakujoshi words in one setnences.

DoubledJoshiValidator() - Constructor for class cc.redpen.validator.sentence.DoubledJoshiValidator

DoubledWordValidator - Class in cc.redpen.validator.sentence

DoubledWordValidator() - Constructor for class cc.redpen.validator.sentence.DoubledWordValidator

DoubleNegativeValidator - Class in cc.redpen.validator.sentence

Detect double negative expressions in Japanese texts.

DoubleNegativeValidator() - Constructor for class cc.redpen.validator.sentence.DoubleNegativeValidator

DuplicatedSectionValidator - Class in cc.redpen.validator.section

DuplicatedSectionValidator check if there are highly similar section pairs.

DuplicatedSectionValidator() - Constructor for class cc.redpen.validator.section.DuplicatedSectionValidator

E

element(Token) - Method in interface cc.redpen.parser.latex.StreamParser.Listener

EndOfSentenceDetector - Class in cc.redpen.util

Utility class to handle a string.

EndOfSentenceDetector(Pattern) - Constructor for class cc.redpen.util.EndOfSentenceDetector

Constructor.

EndOfSentenceDetector(Pattern, List<String>) - Constructor for class cc.redpen.util.EndOfSentenceDetector

Constructor.

EndOfSentenceValidator - Class in cc.redpen.validator.sentence

This validator check if the style end of sentence is American style.

EndOfSentenceValidator() - Constructor for class cc.redpen.validator.sentence.EndOfSentenceValidator

equals(Object) - Method in class cc.redpen.config.Symbol

equals(Object) - Method in class cc.redpen.config.SymbolTable

equals(Object) - Method in class cc.redpen.model.Document

equals(Object) - Method in class cc.redpen.model.Sentence

equals(Token) - Method in class cc.redpen.parser.latex.Token

equals(Object) - Method in class cc.redpen.parser.LineOffset

equals(Object) - Method in class cc.redpen.RedPen

equals(Object) - Method in class cc.redpen.tokenizer.TokenElement

equals(Object) - Method in class cc.redpen.validator.ExpressionRule

equals(Object) - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

equals(Object) - Method in class cc.redpen.validator.section.ParagraphNumberValidator

equals(Object) - Method in class cc.redpen.validator.section.ParagraphStartWithValidator

equals(Object) - Method in class cc.redpen.validator.section.SectionLengthValidator

equals(Object) - Method in class cc.redpen.validator.sentence.CommaNumberValidator

equals(Object) - Method in class cc.redpen.validator.sentence.ContractionValidator

equals(Object) - Method in class cc.redpen.validator.sentence.DoubledWordValidator

equals(Object) - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

equals(Object) - Method in class cc.redpen.validator.sentence.InvalidExpressionValidator

equals(Object) - Method in class cc.redpen.validator.sentence.InvalidWordValidator

equals(Object) - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

equals(Object) - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

equals(Object) - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

equals(Object) - Method in class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

equals(Object) - Method in class cc.redpen.validator.sentence.SpellingValidator

equals(Object) - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

equals(Object) - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

equals(Object) - Method in class cc.redpen.validator.sentence.WordNumberValidator

error(SAXParseException) - Method in class cc.redpen.util.SAXErrorHandler

ExpressionRule - Class in cc.redpen.validator

ExpressionRule() - Constructor for class cc.redpen.validator.ExpressionRule

extract(String, List<Pair<Integer, Integer>>) - Method in class cc.redpen.parser.SentenceExtractor

Get Sentence lists.

F

fatalError(SAXParseException) - Method in class cc.redpen.util.SAXErrorHandler

first - Variable in class cc.redpen.util.Pair

flush() - Method in class cc.redpen.parser.latex.Flusher

Flusher - Class in cc.redpen.parser.latex

Flusher(List<Character>) - Constructor for class cc.redpen.parser.latex.Flusher

format(PrintWriter, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.Formatter

Format and print the errors for a set of documents

format(OutputStream, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.Formatter

Format and print the errors for a set of documents

format(Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.Formatter

Format errors for a set of documents as a String

format(Document, List<ValidationError>) - Method in class cc.redpen.formatter.Formatter

Format the errors for a given document

format(PrintWriter, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.JSONFormatter

format(Document, List<ValidationError>) - Method in class cc.redpen.formatter.JSONFormatter

format(PrintWriter, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.PlainBySentenceFormatter

format(PrintWriter, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.PlainFormatter

format(PrintWriter, Map<Document, List<ValidationError>>) - Method in class cc.redpen.formatter.XMLFormatter

formatError(Document, ValidationError) - Method in class cc.redpen.formatter.Formatter

Format a single error as a string

formatError(Document, ValidationError) - Method in class cc.redpen.formatter.JSONFormatter

formatError(Document, ValidationError) - Method in class cc.redpen.formatter.PlainBySentenceFormatter

formatError(Document, ValidationError) - Method in class cc.redpen.formatter.PlainFormatter

formatError(Document, ValidationError) - Method in class cc.redpen.formatter.XMLFormatter

Formatter - Class in cc.redpen.formatter

Formatter - Format and write RedPen errors

Formatter() - Constructor for class cc.redpen.formatter.Formatter

FormatterUtils - Class in cc.redpen.util

Formatter utilities

FormatterUtils() - Constructor for class cc.redpen.util.FormatterUtils

FrequentSentenceStartValidator - Class in cc.redpen.validator.section

Check that too many sentences don't start with the same words

FrequentSentenceStartValidator() - Constructor for class cc.redpen.validator.section.FrequentSentenceStartValidator

G

getAttribute(String) - Method in class cc.redpen.config.ValidatorConfiguration

Get attribute value.

getAttributes() - Method in class cc.redpen.config.ValidatorConfiguration

Return the attributes map

getBrokenLineSeparator() - Method in class cc.redpen.parser.SentenceExtractor

Return the string that should be used to re-join lines broken with \n in

For English, this is a space.

getConfigAttribute(String) - Method in class cc.redpen.validator.Validator

getConfigAttribute(String, String) - Method in class cc.redpen.validator.Validator

getConfigAttributeAsBoolean(String, boolean) - Method in class cc.redpen.validator.Validator

getConfigAttributeAsDouble(String, double) - Method in class cc.redpen.validator.Validator

getConfigAttributeAsInt(String, int) - Method in class cc.redpen.validator.Validator

getConfigAttributes() - Method in class cc.redpen.validator.Validator

Return the configuration attributes

getConfiguration() - Method in class cc.redpen.RedPen

Get the configuration object for this RedPen

getConfigurationName() - Method in class cc.redpen.config.ValidatorConfiguration

Get configuration name.

getContent() - Method in class cc.redpen.model.Sentence

Get content of sentence.

getContent() - Method in class cc.redpen.parser.markdown.CandidateSentence

getContents() - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

getDeletionCost() - Static method in class cc.redpen.util.LevenshteinDistance

Get the cost for "deletion".

getDictionary(String) - Static method in class cc.redpen.util.SpellingUtils

Get the default dictionary entries for the specified language

getDistance(CharSequence, CharSequence) - Static method in class cc.redpen.util.LevenshteinDistance

Get the Levenshtein distance for given two strings.

getEndPosition() - Method in class cc.redpen.validator.ValidationError

Get error end position.

getFileName() - Method in class cc.redpen.model.Document

Get file name.

getFormatterByName(String) - Static method in class cc.redpen.util.FormatterUtils

Return a new formatter instance from its simple (command line) name

getHeaderContent(int) - Method in class cc.redpen.model.Section

Get iterator of header sentences.

getHeaderContents() - Method in class cc.redpen.model.Section

Get iterator of header sentences.

getHeaderContentsListSize() - Method in class cc.redpen.model.Section

Get the number of sentences in header.

getIndent() - Method in class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

If the underlying JRuby object is a list item, then this variable is the indent of that list item.

getInsertionCost() - Static method in class cc.redpen.util.LevenshteinDistance

Get the cost for "insertion".

getInstance(String) - Static method in class cc.redpen.validator.ValidatorFactory

getInstance(ValidatorConfiguration, SymbolTable) - Static method in class cc.redpen.validator.ValidatorFactory

getInvalidChars() - Method in class cc.redpen.config.Symbol

Get invalid characters.

getJoinedHeaderContents() - Method in class cc.redpen.model.Section

Get iterator of header sentences.

getLang() - Method in class cc.redpen.config.Configuration

returns language targeted by this configuration

getLang() - Method in class cc.redpen.config.SymbolTable

getLastSection() - Method in class cc.redpen.model.Document.DocumentBuilder

Get last Section.

getLastSection() - Method in class cc.redpen.model.Document

Get last Section.

getLevel() - Method in class cc.redpen.model.ListElement

Get indentation level.

getLevel() - Method in class cc.redpen.model.Section

Get level of section.

getLineNo() - Method in class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

This returned the line number stored inside the JRuby object.

getLineNum() - Method in class cc.redpen.parser.markdown.CandidateSentence

getLineNum() - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

getLineNumber() - Method in class cc.redpen.model.Sentence

Get line number where the sentence starts.

getLineNumber() - Method in class cc.redpen.validator.ValidationError

Get line number in which the error occurs.

getLink() - Method in class cc.redpen.parser.markdown.CandidateSentence

getLinks() - Method in class cc.redpen.model.Sentence

Return links the sentence contains.

getLinks() - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

getListBlock(int) - Method in class cc.redpen.model.Section

Get specified list block.

getListBlocks() - Method in class cc.redpen.model.Section

Get specified list block.

getListElement(int) - Method in class cc.redpen.model.ListBlock

Get iterator of list elements.

getListElements() - Method in class cc.redpen.model.ListBlock

Get iterator of list elements.

getLocalizedErrorMessage(String, Object...) - Method in class cc.redpen.validator.JavaScriptValidator

getLocalizedErrorMessage(String, Object...) - Method in class cc.redpen.validator.Validator

returns localized error message for the given key formatted with argument

getMessage() - Method in class cc.redpen.validator.ValidationError

Get error message.

getNames() - Method in class cc.redpen.config.SymbolTable

Get the character names in the dictionary.

getNumberOfListElements() - Method in class cc.redpen.model.ListBlock

Get the number of list elements.

getNumberOfLists() - Method in class cc.redpen.model.Section

Get size of list.

getNumberOfParagraphs() - Method in class cc.redpen.model.Section

Get the number of paragraphs in the section.

getNumberOfSentences() - Method in class cc.redpen.model.ListElement

Get the number of content sentence.

getNumberOfSentences() - Method in class cc.redpen.model.Paragraph

Get the number of sentences in the paragraph.

getNumberOfSubsections() - Method in class cc.redpen.model.Section

Get the size of subsections.

getOffset(int) - Method in class cc.redpen.model.Sentence

Get offset position for specified character position.

getOffset() - Method in class cc.redpen.tokenizer.TokenElement

getOffsetMap() - Method in class cc.redpen.parser.markdown.CandidateSentence

getOffsetMap() - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

getOffsetMapSize() - Method in class cc.redpen.model.Sentence

Get size of offset mapping table (the size should be same as the content length).

getOffsetPosition(LineOffset) - Method in class cc.redpen.model.Sentence

Get the position of the supplied offset (ie: the position in the source text) in this sentence's normalized content

getParagraph(int) - Method in class cc.redpen.model.Section

Get the specified paragraph.

getParagraphs() - Method in class cc.redpen.model.Section

Get the iterator of paragraphs of section.

getParentSection() - Method in class cc.redpen.model.Section

Get super section.

getRangedLinks(int, int) - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

getSection(int) - Method in class cc.redpen.model.Document.DocumentBuilder

Get the specified section.

getSection(int) - Method in class cc.redpen.model.Document

Get the specified section.

getSentence(int) - Method in class cc.redpen.model.ListElement

Given sentence id, return the content of sentence.

getSentence(int) - Method in class cc.redpen.model.Paragraph

Get the specified sentence.

getSentence() - Method in class cc.redpen.validator.ValidationError

Get sentence containing the error.

getSentenceEndPosition(String) - Method in class cc.redpen.parser.SentenceExtractor

Given string, return sentence end position.

getSentenceEndPosition(String) - Method in class cc.redpen.util.EndOfSentenceDetector

Get sentence end position.

getSentenceEndPosition(String, int) - Method in class cc.redpen.util.EndOfSentenceDetector

Get sentence end position.

getSentences() - Method in class cc.redpen.model.ListElement

Get content of list element.

getSentences() - Method in class cc.redpen.model.Paragraph

Get the iterator of sentences.

getSourceText() - Method in class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

The source text is a new block element inserted into the JRuby object by the Ruby code in redpen's AsciiDocParser.java.

getStartColumnNumber() - Method in class cc.redpen.validator.ValidationError

Get column number in which the error occurs.

getStartPosition() - Method in class cc.redpen.validator.ValidationError

Get error start position.

getStartPositionOffset() - Method in class cc.redpen.model.Sentence

Get start column offset where the sentence starts.

getStartPositionOffset() - Method in class cc.redpen.parser.markdown.CandidateSentence

getSubSection(int) - Method in class cc.redpen.model.Section

Get the iterator of subsections.

getSubstitutionCost() - Static method in class cc.redpen.util.LevenshteinDistance

Get the cost for "substitution".

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.ContractionValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.DoubledJoshiValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.DoubleNegativeValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.HankakuKanaValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.InvalidWordValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.KatakanaEndHyphenValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.OkuriganaValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.QuotationValidator

getSupportedLanguages() - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

getSupportedLanguages() - Method in class cc.redpen.validator.Validator

Return an array of languages supported by this validator Validator provides empty implementation.

getSurface() - Method in class cc.redpen.tokenizer.TokenElement

getSymbol(SymbolType) - Method in class cc.redpen.config.SymbolTable

Get the character specified with the name.

getSymbolByValue(char) - Method in class cc.redpen.config.SymbolTable

Get the character specified with the value.

getSymbolTable() - Method in class cc.redpen.config.Configuration

Get SymbolTable.

getSymbolTable() - Method in class cc.redpen.validator.Validator

getTags() - Method in class cc.redpen.tokenizer.TokenElement

getTokenizer() - Method in class cc.redpen.config.Configuration

returns Tokenizer aasociated with this configuration

getTokens() - Method in class cc.redpen.model.Sentence

Get a set of tokenized words in the sentence.

getType() - Method in class cc.redpen.config.Symbol

Get name of character.

getType() - Method in class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

The type element of the var table returns the type of this block, for example 'ulist' or 'list_time'

getValidatorClassName() - Method in class cc.redpen.config.ValidatorConfiguration

Get validator class name

getValidatorConfigs() - Method in class cc.redpen.config.Configuration

Get validator configurations.

getValidatorName() - Method in class cc.redpen.validator.ValidationError

Get validator name.

getValidators() - Method in class cc.redpen.RedPen

Get validators associated with this RedPen instance

getValue() - Method in class cc.redpen.config.Symbol

Get value of character.

getValue() - Method in class org.asciidoctor.RedPenTreeProcessor.BlockAccessor

The block's value is usually its processed or converted text form

getValueOrFallbackToDefault(SymbolType) - Method in class cc.redpen.config.SymbolTable

Detect the specified character is exit in the dictionary.

H

HankakuKanaValidator - Class in cc.redpen.validator.sentence

HankakuKanaValidator() - Constructor for class cc.redpen.validator.sentence.HankakuKanaValidator

hashCode() - Method in class cc.redpen.config.Symbol

hashCode() - Method in class cc.redpen.config.SymbolTable

hashCode() - Method in class cc.redpen.model.Document

hashCode() - Method in class cc.redpen.model.Sentence

hashCode() - Method in class cc.redpen.parser.LineOffset

hashCode() - Method in class cc.redpen.RedPen

hashCode() - Method in class cc.redpen.tokenizer.TokenElement

hashCode() - Method in class cc.redpen.validator.ExpressionRule

hashCode() - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

hashCode() - Method in class cc.redpen.validator.section.ParagraphNumberValidator

hashCode() - Method in class cc.redpen.validator.section.ParagraphStartWithValidator

hashCode() - Method in class cc.redpen.validator.section.SectionLengthValidator

hashCode() - Method in class cc.redpen.validator.sentence.CommaNumberValidator

hashCode() - Method in class cc.redpen.validator.sentence.ContractionValidator

hashCode() - Method in class cc.redpen.validator.sentence.DoubledWordValidator

hashCode() - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

hashCode() - Method in class cc.redpen.validator.sentence.InvalidExpressionValidator

hashCode() - Method in class cc.redpen.validator.sentence.InvalidWordValidator

hashCode() - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

hashCode() - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

hashCode() - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

hashCode() - Method in class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

hashCode() - Method in class cc.redpen.validator.sentence.SpellingValidator

hashCode() - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

hashCode() - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

hashCode() - Method in class cc.redpen.validator.sentence.WordNumberValidator

HyphenationValidator - Class in cc.redpen.validator.sentence

Ensure groups of words that are hyphenated in the dictionary are hyphenated in the sentence

HyphenationValidator() - Constructor for class cc.redpen.validator.sentence.HyphenationValidator

I

init() - Method in class cc.redpen.validator.JavaScriptValidator

init() - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

init() - Method in class cc.redpen.validator.section.FrequentSentenceStartValidator

init() - Method in class cc.redpen.validator.section.ParagraphNumberValidator

init() - Method in class cc.redpen.validator.section.ParagraphStartWithValidator

init() - Method in class cc.redpen.validator.section.SectionLengthValidator

init() - Method in class cc.redpen.validator.section.UnexpandedAcronymValidator

init() - Method in class cc.redpen.validator.section.WordFrequencyValidator

init() - Method in class cc.redpen.validator.sentence.CommaNumberValidator

init() - Method in class cc.redpen.validator.sentence.DoubledJoshiValidator

init() - Method in class cc.redpen.validator.sentence.DoubledWordValidator

init() - Method in class cc.redpen.validator.sentence.DoubleNegativeValidator

init() - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

init() - Method in class cc.redpen.validator.sentence.InvalidExpressionValidator

init() - Method in class cc.redpen.validator.sentence.InvalidWordValidator

init() - Method in class cc.redpen.validator.sentence.KatakanaEndHyphenValidator

init() - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

init() - Method in class cc.redpen.validator.sentence.NumberFormatValidator

init() - Method in class cc.redpen.validator.sentence.OkuriganaValidator

init() - Method in class cc.redpen.validator.sentence.ParenthesizedSentenceValidator

init() - Method in class cc.redpen.validator.sentence.QuotationValidator

init() - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

init() - Method in class cc.redpen.validator.sentence.SpaceBetweenAlphabeticalWordValidator

init() - Method in class cc.redpen.validator.sentence.SpellingValidator

init() - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

init() - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

init() - Method in class cc.redpen.validator.sentence.WeakExpressionValidator

init() - Method in class cc.redpen.validator.sentence.WordNumberValidator

init() - Method in class cc.redpen.validator.Validator

Validation initialization, called after the configuration and symbol tables have been assigned

InvalidExpressionValidator - Class in cc.redpen.validator.sentence

Validate input sentences contain invalid expression.

InvalidExpressionValidator() - Constructor for class cc.redpen.validator.sentence.InvalidExpressionValidator

InvalidSymbolValidator - Class in cc.redpen.validator.sentence

Validate if there is invalid characters in sentences.

InvalidSymbolValidator() - Constructor for class cc.redpen.validator.sentence.InvalidSymbolValidator

InvalidWordValidator - Class in cc.redpen.validator.sentence

Detect invalid word occurrences.

InvalidWordValidator() - Constructor for class cc.redpen.validator.sentence.InvalidWordValidator

isBasicLatin(char) - Static method in class cc.redpen.util.StringUtils

isBlankLine() - Method in class cc.redpen.parser.latex.Token

isEmptyAsTextile() - Method in class cc.redpen.parser.latex.Token

isFirstSentence() - Method in class cc.redpen.model.Sentence

Detect the sentence is the first sentence of a paragraph.

isKatakana(char) - Static method in class cc.redpen.util.StringUtils

isKatakanaEndHyphen(StringBuilder) - Static method in class cc.redpen.validator.sentence.KatakanaEndHyphenValidator

isNeedAfterSpace() - Method in class cc.redpen.config.Symbol

Get the flag to know the character should have a space.

isNeedBeforeSpace() - Method in class cc.redpen.config.Symbol

Get the flag to know the character should have a space.

iterator() - Method in class cc.redpen.model.Document

J

JapaneseStyleValidator - Class in cc.redpen.validator.sentence

Validate Japanese document if it contains both Desumasu and Dearu styles.

JapaneseStyleValidator() - Constructor for class cc.redpen.validator.sentence.JapaneseStyleValidator

JapaneseTokenizer - Class in cc.redpen.tokenizer

JapaneseTokenizer() - Constructor for class cc.redpen.tokenizer.JapaneseTokenizer

JavaScriptValidator - Class in cc.redpen.validator

A Validator implementation load JavaScript dynamically.

JavaScriptValidator() - Constructor for class cc.redpen.validator.JavaScriptValidator

JSONBySentenceFormatter - Class in cc.redpen.formatter

JSON error formatter, collating errors by sentence

JSONBySentenceFormatter() - Constructor for class cc.redpen.formatter.JSONBySentenceFormatter

JSONFormatter - Class in cc.redpen.formatter

JSON error formatter

JSONFormatter() - Constructor for class cc.redpen.formatter.JSONFormatter

K

KatakanaEndHyphenValidator - Class in cc.redpen.validator.sentence

Validate the end hyphens of Katakana words in Japanese documents.

KatakanaEndHyphenValidator() - Constructor for class cc.redpen.validator.sentence.KatakanaEndHyphenValidator

KatakanaSpellCheckValidator - Class in cc.redpen.validator.sentence

Validate the correctness of Katakana word spelling.

KatakanaSpellCheckValidator() - Constructor for class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

KEY_VALUE - Static variable in class cc.redpen.validator.Validator

Resource Extractor loads key-value dictionary

L

LATEX - Static variable in interface cc.redpen.parser.DocumentParser

LaTeXProcessor - Class in cc.redpen.parser.latex

LaTeXProcessor() - Constructor for class cc.redpen.parser.latex.LaTeXProcessor

LevenshteinDistance - Class in cc.redpen.util

Levenshtein Distance(a.k.a.

Lexer - Class in cc.redpen.parser.latex

Experimental lexer for LaTeX.

lineNum - Variable in class cc.redpen.parser.LineOffset

LineOffset - Class in cc.redpen.parser

LineOffset(int, int) - Constructor for class cc.redpen.parser.LineOffset

Constructor.

ListBlock - Class in cc.redpen.model

Represent List in semi-structured format such as wiki.

ListBlock() - Constructor for class cc.redpen.model.ListBlock

Constructor.

ListElement - Class in cc.redpen.model

Element of List in semi-structured text format such as wiki.

ListElement(int, List<Sentence>) - Constructor for class cc.redpen.model.ListElement

Constructor.

load(File) - Method in class cc.redpen.ConfigurationLoader

load RedPen settings.

load(InputStream) - Method in class cc.redpen.ConfigurationLoader

load RedPen configuration.

loadCachedFromFile(File, String) - Method in class cc.redpen.util.DictionaryLoader

returns word list loaded from file

loadCachedFromResource(String, String) - Method in class cc.redpen.util.DictionaryLoader

returns word list loaded from resource

loadDictionary(String) - Static method in class cc.redpen.util.SpellingUtils

loadFromResource(String) - Method in class cc.redpen.ConfigurationLoader

load RedPen settings.

loadFromString(String) - Method in class cc.redpen.ConfigurationLoader

load RedPen settings.

M

MARKDOWN - Static variable in interface cc.redpen.parser.DocumentParser

match(List<TokenElement>) - Method in class cc.redpen.validator.ExpressionRule

merge(List<CandidateSentence>) - Static method in class cc.redpen.parser.markdown.MergedCandidateSentence

MergedCandidateSentence - Class in cc.redpen.parser.markdown

MergedCandidateSentence(int, String, Map<LineOffset, String>, List<LineOffset>) - Constructor for class cc.redpen.parser.markdown.MergedCandidateSentence

N

NumberFormatValidator - Class in cc.redpen.validator.sentence

Ensure numbers are formatted correctly, with commas (or fullstops) in the correct place

NumberFormatValidator() - Constructor for class cc.redpen.validator.sentence.NumberFormatValidator

O

of(String) - Static method in interface cc.redpen.parser.DocumentParser

offset - Variable in class cc.redpen.parser.LineOffset

OkuriganaValidator - Class in cc.redpen.validator.sentence

OkuriganaValidator() - Constructor for class cc.redpen.validator.sentence.OkuriganaValidator

on(List) - Static method in class cc.redpen.parser.latex.Flusher

on(char[]) - Static method in class cc.redpen.parser.latex.Lexer

on(String) - Static method in class cc.redpen.parser.latex.Lexer

org.asciidoctor - package org.asciidoctor

overrideSymbol(Symbol) - Method in class cc.redpen.config.SymbolTable

Override a symbol with a new definition

P

p - Variable in class cc.redpen.parser.latex.Token

Pair<A,B> - Class in cc.redpen.util

Pair(A, B) - Constructor for class cc.redpen.util.Pair

Paragraph - Class in cc.redpen.model

Represent a paragraph of text.

Paragraph() - Constructor for class cc.redpen.model.Paragraph

Constructor.

ParagraphNumberValidator - Class in cc.redpen.validator.section

Validate paragraph number.

ParagraphNumberValidator() - Constructor for class cc.redpen.validator.section.ParagraphNumberValidator

ParagraphStartWithValidator - Class in cc.redpen.validator.section

Validate whether paragraph start as specified.

ParagraphStartWithValidator() - Constructor for class cc.redpen.validator.section.ParagraphStartWithValidator

ParenthesizedSentenceValidator - Class in cc.redpen.validator.sentence

Warn if too many (or overly long (or nested parenthesized sentences (where you do this))) are used in a sentence

ParenthesizedSentenceValidator() - Constructor for class cc.redpen.validator.sentence.ParenthesizedSentenceValidator

parse(InputStream, Optional<String>, SentenceExtractor, RedPenTokenizer) - Method in class cc.redpen.parser.AsciiDocParser

parse(String, SentenceExtractor, RedPenTokenizer) - Method in class cc.redpen.parser.BaseDocumentParser

parse(File, SentenceExtractor, RedPenTokenizer) - Method in class cc.redpen.parser.BaseDocumentParser

parse(InputStream, SentenceExtractor, RedPenTokenizer) - Method in interface cc.redpen.parser.DocumentParser

Given input stream, return Document instance from a stream.

parse(InputStream, Optional<String>, SentenceExtractor, RedPenTokenizer) - Method in interface cc.redpen.parser.DocumentParser

Given input stream, return Document instance from a stream.

parse(String, SentenceExtractor, RedPenTokenizer) - Method in interface cc.redpen.parser.DocumentParser

Given content, return Document instance for the specified file.

parse(File, SentenceExtractor, RedPenTokenizer) - Method in interface cc.redpen.parser.DocumentParser

Given input file name, return Document instance for the specified file.

parse(char[], Document.DocumentBuilder, SentenceExtractor) - Method in class cc.redpen.parser.latex.LaTeXProcessor

parse() - Method in class cc.redpen.parser.latex.Lexer

parse() - Method in class cc.redpen.parser.latex.StreamParser

parse(InputStream, Optional<String>, SentenceExtractor, RedPenTokenizer) - Method in class cc.redpen.parser.PlainTextParser

parse(DocumentParser, InputStream) - Method in class cc.redpen.RedPen

parse given input stream.

parse(DocumentParser, String) - Method in class cc.redpen.RedPen

parse given content.

parse(DocumentParser, File[]) - Method in class cc.redpen.RedPen

parse given files.

PARSER_MAP - Static variable in interface cc.redpen.parser.DocumentParser

PLAIN - Static variable in interface cc.redpen.parser.DocumentParser

PlainBySentenceFormatter - Class in cc.redpen.formatter

Format errors as string messages, collated by sentence

PlainBySentenceFormatter() - Constructor for class cc.redpen.formatter.PlainBySentenceFormatter

PlainFormatter - Class in cc.redpen.formatter

Format errors as string messages.

PlainFormatter() - Constructor for class cc.redpen.formatter.PlainFormatter

PlainTextParser - Class in cc.redpen.parser

Parser for plain text file.

pos - Variable in class cc.redpen.parser.latex.Token

Position - Class in cc.redpen.parser.latex

Position data type.

Position(int, int) - Constructor for class cc.redpen.parser.latex.Position

Position(Position) - Constructor for class cc.redpen.parser.latex.Position

preValidate(Sentence) - Method in class cc.redpen.validator.JavaScriptValidator

preValidate(Section) - Method in class cc.redpen.validator.JavaScriptValidator

preValidate(Section) - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

preValidate(Sentence) - Method in class cc.redpen.validator.sentence.ContractionValidator

preValidate(Sentence) - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

preValidate(Sentence) - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

preValidate(Sentence) - Method in class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

preValidate(Sentence) - Method in class cc.redpen.validator.Validator

Process input blocks before run validation.

preValidate(Section) - Method in class cc.redpen.validator.Validator

Process input blocks before run validation.

process(Document) - Method in class org.asciidoctor.RedPenTreeProcessor

Process a AsciiDoctorJ document

processParagraph(String, String, List<Sentence>) - Method in class org.asciidoctor.RedPenTreeProcessor

Process a paragraph of processed text.

Q

QuotationValidator - Class in cc.redpen.validator.sentence

Validator to validate quotation characters.

QuotationValidator() - Constructor for class cc.redpen.validator.sentence.QuotationValidator

R

RedPen - Class in cc.redpen

Validate all input files using appended Validators.

RedPen(File) - Constructor for class cc.redpen.RedPen

constructs RedPen with specified config file.

RedPen(String) - Constructor for class cc.redpen.RedPen

constructs RedPen with specified config file path.

RedPen(Configuration) - Constructor for class cc.redpen.RedPen

constructs RedPen with specified configuration.

RedPenException - Exception in cc.redpen

Error used to model the failure of Validators.

RedPenException() - Constructor for exception cc.redpen.RedPenException

Constructor.

RedPenException(String) - Constructor for exception cc.redpen.RedPenException

Constructor.

RedPenException(String, Exception) - Constructor for exception cc.redpen.RedPenException

Constructor.

RedPenException(Exception) - Constructor for exception cc.redpen.RedPenException

Constructor.

RedPenTokenizer - Interface in cc.redpen.tokenizer

RedPenTreeProcessor - Class in org.asciidoctor

AsciiDoctor tree processor, for use with the "redpen" AsciiDoctor backend, used to populate a RedPen document

This (unfortunately) has to be under an 'org' or 'com' package, rather than a 'cc' package, due to the way JRuby and AsciiDoctor handle the registration of this class.

RedPenTreeProcessor(Document.DocumentBuilder, SentenceExtractor, Map<String, Object>) - Constructor for class org.asciidoctor.RedPenTreeProcessor

Build a tree processer that uses the supplied documentBuilder and sentenceExtractor

RedPenTreeProcessor.BlockAccessor - Class in org.asciidoctor

helper class to inspect and access important asciidoctor information obscured by JRuby (and AsciiDoctorJ)

row - Variable in class cc.redpen.parser.latex.Position

RULE - Static variable in class cc.redpen.validator.Validator

Resource Extractor loads rule dictionary

RuleExtractor - Class in cc.redpen.util

RuleExtractor() - Constructor for class cc.redpen.util.RuleExtractor

run(String) - Static method in class cc.redpen.util.RuleExtractor

Create a rule from input sentence.

S

SAXErrorHandler - Class in cc.redpen.util

Error handler class of SAX parser.

SAXErrorHandler() - Constructor for class cc.redpen.util.SAXErrorHandler

second - Variable in class cc.redpen.util.Pair

Section - Class in cc.redpen.model

Represent a section in semi-structured text format such as wiki.

Section(int) - Constructor for class cc.redpen.model.Section

Constructor.

Section(int, List<Sentence>) - Constructor for class cc.redpen.model.Section

Constructor.

Section(int, String) - Constructor for class cc.redpen.model.Section

Constructor.

SectionLengthValidator - Class in cc.redpen.validator.section

Validate the length of one section.

SectionLengthValidator() - Constructor for class cc.redpen.validator.section.SectionLengthValidator

Sentence - Class in cc.redpen.model

Sentence block in a Document.

Sentence(String, int) - Constructor for class cc.redpen.model.Sentence

Constructor.

Sentence(String, int, int) - Constructor for class cc.redpen.model.Sentence

Constructor.

Sentence(String, List<LineOffset>, List<String>) - Constructor for class cc.redpen.model.Sentence

SentenceExtractor - Class in cc.redpen.parser

Utility Class to extract a Sentence list from given String.

SentenceExtractor(SymbolTable) - Constructor for class cc.redpen.parser.SentenceExtractor

Constructor.

SentenceLengthValidator - Class in cc.redpen.validator.sentence

Validate input sentences contain more characters more than specified.

SentenceLengthValidator() - Constructor for class cc.redpen.validator.sentence.SentenceLengthValidator

setContent(String) - Method in class cc.redpen.model.Sentence

Set content of sentence.

setContent(String) - Method in class cc.redpen.parser.markdown.CandidateSentence

setDeletionCost(int) - Static method in class cc.redpen.util.LevenshteinDistance

Set the cost for "deletion".

setErrorList(List<ValidationError>) - Method in class cc.redpen.validator.Validator

setFileName(String) - Method in class cc.redpen.model.Document.DocumentBuilder

Set file name.

setInsertionCost(int) - Static method in class cc.redpen.util.LevenshteinDistance

Set the cost for "insertion".

setIsFirstSentence(boolean) - Method in class cc.redpen.model.Sentence

Set a flag to detect if the sentence is a first sentence of a paragraph.

setLanguage(String) - Method in class cc.redpen.config.Configuration.ConfigurationBuilder

setLengthLimit(int) - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

Set maximum length of sentence.

setLevel(int) - Method in class cc.redpen.model.Section

Set level of section.

setLineNumber(int) - Method in class cc.redpen.model.Sentence

Set line number where the sentence starts.

setLink(String) - Method in class cc.redpen.parser.markdown.CandidateSentence

setMaxLength(int) - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

setMaxParagraphNumber(int) - Method in class cc.redpen.validator.section.ParagraphNumberValidator

setMaxSectionLength(int) - Method in class cc.redpen.validator.section.SectionLengthValidator

setOffsetMap(List<LineOffset>) - Method in class cc.redpen.model.Sentence

Set the offset mapping table which contains character position to column offset in line.

setParentSection(Section) - Method in class cc.redpen.model.Section

Set super section.

setSubstitutionCost(int) - Static method in class cc.redpen.util.LevenshteinDistance

Set the cost for "substitution".

setSynonyms(Map<String, String>) - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

setTokens(List<TokenElement>) - Method in class cc.redpen.model.Sentence

Set a set of tokenized words.

setType(String) - Method in class cc.redpen.config.Configuration.ConfigurationBuilder

size() - Method in class cc.redpen.model.Document

Get the size of sections in the file.

SpaceBeginningOfSentenceValidator - Class in cc.redpen.validator.sentence

Validate input sentences except for first sentence of a paragraph start with a space.

SpaceBeginningOfSentenceValidator() - Constructor for class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

SpaceBetweenAlphabeticalWordValidator - Class in cc.redpen.validator.sentence

SpaceBetweenAlphabeticalWordValidator() - Constructor for class cc.redpen.validator.sentence.SpaceBetweenAlphabeticalWordValidator

SpellingUtils - Class in cc.redpen.util

Spelling utility

SpellingUtils() - Constructor for class cc.redpen.util.SpellingUtils

SpellingValidator - Class in cc.redpen.validator.sentence

SpellingValidator() - Constructor for class cc.redpen.validator.sentence.SpellingValidator

StartWithCapitalLetterValidator - Class in cc.redpen.validator.sentence

Check if the input sentence start with a capital letter.

StartWithCapitalLetterValidator() - Constructor for class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

StreamParser - Class in cc.redpen.parser.latex

Experimental stream mode LaTeX parser prototype.

StreamParser(char[], StreamParser.Listener) - Constructor for class cc.redpen.parser.latex.StreamParser

StreamParser(String, StreamParser.Listener) - Constructor for class cc.redpen.parser.latex.StreamParser

StreamParser.Listener - Interface in cc.redpen.parser.latex

StringUtils - Class in cc.redpen.util

StringUtils() - Constructor for class cc.redpen.util.StringUtils

SuccessiveWordValidator - Class in cc.redpen.validator.sentence

SuccessiveWordValidator() - Constructor for class cc.redpen.validator.sentence.SuccessiveWordValidator

SuggestExpressionValidator - Class in cc.redpen.validator.sentence

If input sentences contain invalid expressions, this validator returns the errors with corrected expressions.

SuggestExpressionValidator() - Constructor for class cc.redpen.validator.sentence.SuggestExpressionValidator

Symbol - Class in cc.redpen.config

Represent a character settings.

Symbol(SymbolType, char) - Constructor for class cc.redpen.config.Symbol

Constructor.

Symbol(SymbolType, char, String) - Constructor for class cc.redpen.config.Symbol

Constructor.

Symbol(SymbolType, char, String, boolean, boolean) - Constructor for class cc.redpen.config.Symbol

Constructor.

SymbolTable - Class in cc.redpen.config

Configuration table of characters used in RedPen.

SymbolType - Enum in cc.redpen.config

SymbolWithSpaceValidator - Class in cc.redpen.validator.sentence

Validate symbol has before and after symbols.

SymbolWithSpaceValidator() - Constructor for class cc.redpen.validator.sentence.SymbolWithSpaceValidator

T

t - Variable in class cc.redpen.parser.latex.Token

toFileContent(RootNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

Traverse markdown tree that parsed Pegdown.

ToFileContentSerializer - Class in cc.redpen.parser.markdown

Using Pegdown Parser.

ToFileContentSerializer(Document.DocumentBuilder, List<Integer>, SentenceExtractor) - Constructor for class cc.redpen.parser.markdown.ToFileContentSerializer

Constructor.

Token - Class in cc.redpen.parser.latex

Token data type.

Token(String, String, Position) - Constructor for class cc.redpen.parser.latex.Token

Token(String, char, Position) - Constructor for class cc.redpen.parser.latex.Token

TokenElement - Class in cc.redpen.tokenizer

TokenElement(String, List<String>, int) - Constructor for class cc.redpen.tokenizer.TokenElement

tokenize(String) - Method in class cc.redpen.tokenizer.JapaneseTokenizer

tokenize(String) - Method in interface cc.redpen.tokenizer.RedPenTokenizer

Tokenize input sentence into tokens.

tokenize(String) - Method in class cc.redpen.tokenizer.WhiteSpaceTokenizer

toString() - Method in class cc.redpen.config.Symbol

toString() - Method in class cc.redpen.config.SymbolTable

toString() - Method in class cc.redpen.model.Document

toString() - Method in class cc.redpen.model.Sentence

toString() - Method in class cc.redpen.parser.latex.Position

toString() - Method in class cc.redpen.parser.latex.Token

toString() - Method in class cc.redpen.parser.LineOffset

toString() - Method in class cc.redpen.parser.markdown.CandidateSentence

toString() - Method in class cc.redpen.parser.markdown.MergedCandidateSentence

toString() - Method in class cc.redpen.parser.PlainTextParser

toString() - Method in class cc.redpen.RedPen

toString() - Method in class cc.redpen.tokenizer.TokenElement

toString() - Method in class cc.redpen.validator.ExpressionRule

toString() - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

toString() - Method in class cc.redpen.validator.section.ParagraphNumberValidator

toString() - Method in class cc.redpen.validator.section.SectionLengthValidator

toString() - Method in class cc.redpen.validator.sentence.CommaNumberValidator

toString() - Method in class cc.redpen.validator.sentence.ContractionValidator

toString() - Method in class cc.redpen.validator.sentence.DoubledWordValidator

toString() - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

toString() - Method in class cc.redpen.validator.sentence.InvalidExpressionValidator

toString() - Method in class cc.redpen.validator.sentence.InvalidWordValidator

toString() - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

toString() - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

toString() - Method in class cc.redpen.validator.sentence.OkuriganaValidator

toString() - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

toString() - Method in class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

toString() - Method in class cc.redpen.validator.sentence.SpellingValidator

toString() - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

toString() - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

toString() - Method in class cc.redpen.validator.sentence.WordNumberValidator

U

UnexpandedAcronymValidator - Class in cc.redpen.validator.section

Ensure that there are candidates for expanded versions of acronyms.

UnexpandedAcronymValidator() - Constructor for class cc.redpen.validator.section.UnexpandedAcronymValidator

V

v - Variable in class cc.redpen.parser.latex.Token

validate(List<Document>) - Method in class cc.redpen.RedPen

validate the input document collection.

validate(Document) - Method in class cc.redpen.RedPen

validate the input document collection.

validate(Document) - Method in class cc.redpen.validator.JavaScriptValidator

validate(Sentence) - Method in class cc.redpen.validator.JavaScriptValidator

validate(Section) - Method in class cc.redpen.validator.JavaScriptValidator

validate(Section) - Method in class cc.redpen.validator.section.DuplicatedSectionValidator

validate(Document) - Method in class cc.redpen.validator.section.FrequentSentenceStartValidator

validate(Section) - Method in class cc.redpen.validator.section.ParagraphNumberValidator

validate(Section) - Method in class cc.redpen.validator.section.ParagraphStartWithValidator

validate(Section) - Method in class cc.redpen.validator.section.SectionLengthValidator

validate(Document) - Method in class cc.redpen.validator.section.UnexpandedAcronymValidator

validate(Document) - Method in class cc.redpen.validator.section.WordFrequencyValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.CommaNumberValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.ContractionValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.DoubledJoshiValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.DoubledWordValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.DoubleNegativeValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.EndOfSentenceValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.HankakuKanaValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.HyphenationValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.InvalidExpressionValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.InvalidSymbolValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.InvalidWordValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.JapaneseStyleValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.KatakanaEndHyphenValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.KatakanaSpellCheckValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.NumberFormatValidator

Search for numbers in the sentence and ensure they are correctly formatted

validate(Sentence) - Method in class cc.redpen.validator.sentence.OkuriganaValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.ParenthesizedSentenceValidator

Look for parenthesized expressions in the sentence and generate an error where appropriate

validate(Sentence) - Method in class cc.redpen.validator.sentence.QuotationValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SentenceLengthValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SpaceBeginningOfSentenceValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SpaceBetweenAlphabeticalWordValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SpellingValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.StartWithCapitalLetterValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SuccessiveWordValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SuggestExpressionValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.SymbolWithSpaceValidator

validate(Sentence) - Method in class cc.redpen.validator.sentence.WeakExpressionValidator

Build up sequences of tokens and see if that sequence exists in the weak-expression dictionary

validate(Sentence) - Method in class cc.redpen.validator.sentence.WordNumberValidator

validate(Document) - Method in class cc.redpen.validator.Validator

validate the input document and returns the invalid points.

validate(Sentence) - Method in class cc.redpen.validator.Validator

validate the input document and returns the invalid points.

validate(Section) - Method in class cc.redpen.validator.Validator

validate the input document and returns the invalid points.

ValidationError - Class in cc.redpen.validator

Error to report invalid point from Validators.

Validator - Class in cc.redpen.validator

Validate input document.

Validator() - Constructor for class cc.redpen.validator.Validator

ValidatorConfiguration - Class in cc.redpen.config

Configuration for Validators.

ValidatorConfiguration(String) - Constructor for class cc.redpen.config.ValidatorConfiguration

Constructor.

ValidatorFactory - Class in cc.redpen.validator

Factory class of validators.

ValidatorFactory() - Constructor for class cc.redpen.validator.ValidatorFactory

valueOf(String) - Static method in enum cc.redpen.config.SymbolType

Returns the enum constant of this type with the specified name.

values() - Static method in enum cc.redpen.config.SymbolType

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in class cc.redpen.RedPen

visit(AbbreviationNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(AutoLinkNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(BlockQuoteNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(CodeNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(ExpImageNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(ExpLinkNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(HeaderNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(BulletListNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(OrderedListNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(ListItemNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(ParaNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(RootNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(SimpleNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(SpecialTextNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(StrikeNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(StrongEmphSuperNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TextNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(VerbatimNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(QuotedNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(ReferenceNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(RefImageNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(RefLinkNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(HtmlBlockNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(InlineHtmlNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(MailLinkNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(WikiLinkNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(SuperNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(Node) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(DefinitionListNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(DefinitionNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(DefinitionTermNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableBodyNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableCaptionNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableCellNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableColumnNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableHeaderNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visit(TableRowNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

visitChildren(SuperNode) - Method in class cc.redpen.parser.markdown.ToFileContentSerializer

W

warning(SAXParseException) - Method in class cc.redpen.util.SAXErrorHandler

WeakExpressionValidator - Class in cc.redpen.validator.sentence

Warn about grammatically weak expressions in the sentence.

WeakExpressionValidator() - Constructor for class cc.redpen.validator.sentence.WeakExpressionValidator

WhiteSpaceTokenizer - Class in cc.redpen.tokenizer

WhiteSpaceTokenizer() - Constructor for class cc.redpen.tokenizer.WhiteSpaceTokenizer

WIKI - Static variable in interface cc.redpen.parser.DocumentParser

WORD_LIST - Static variable in class cc.redpen.validator.Validator

Resource Extractor loads word list

WORD_LIST_LOWERCASED - Static variable in class cc.redpen.validator.Validator

Resource Extractor loads word list while lowercasting lines

WordFrequencyValidator - Class in cc.redpen.validator.section

Ensure that known (dictionary) words are not used too frequently within the document

WordFrequencyValidator() - Constructor for class cc.redpen.validator.section.WordFrequencyValidator

WordNumberValidator - Class in cc.redpen.validator.sentence

Validate input sentences have more words than specified.

WordNumberValidator() - Constructor for class cc.redpen.validator.sentence.WordNumberValidator

X

XMLFormatter - Class in cc.redpen.formatter

XML Output formatter.

XMLFormatter() - Constructor for class cc.redpen.formatter.XMLFormatter

Constructor.

A B C D E F G H I J K L M N O P Q R S T U V W X