Class SpecReader

java.lang.Object

com.vladsch.flexmark.test.util.spec.SpecReader

Direct Known Subclasses:

DumpSpecReader

public class SpecReader
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	SpecReader.State

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	ast
protected StringBuilder	comment
protected int	commentLineNumber
protected final boolean	compoundSections
protected int	contentLineNumber
static final String	EXAMPLE_BREAK
static final String	EXAMPLE_KEYWORD
static final String	EXAMPLE_START
static final String	EXAMPLE_START_NBSP
static final String	EXAMPLE_TEST_BREAK
static final String	EXAMPLE_TEST_START
protected int	exampleNumber
protected final List<SpecExample>	examples
protected StringBuilder	html
protected final @NotNull InputStream	inputStream
protected int	lastSectionLevel
protected int	lineNumber
static final String	OPTIONS_KEYWORD
static final Pattern	OPTIONS_PATTERN
static final String	OPTIONS_STRING
protected String	optionsSet
protected final @NotNull ResourceLocation	resourceLocation
protected String	section
static final String	SECTION_BREAK
protected static final Pattern	SECTION_PATTERN
static final String	SECTION_TEST_BREAK
protected final String[]	sections
protected StringBuilder	source
protected SpecReader.State	state

Constructor Summary

Constructors

Constructor	Description
SpecReader(@NotNull InputStream stream, @NotNull ResourceLocation location, boolean compoundSections)

Method Summary

Modifier and Type	Method	Description
protected void	addSpecExample(@NotNull SpecExample example)
protected void	addSpecLine(String line, boolean isSpecExampleOpen)
static @NotNull SpecReader	create(@NotNull ResourceLocation location, boolean compoundSections)
static <S extends SpecReader> S	create(@NotNull ResourceLocation location, @NotNull SpecReaderFactory<S> readerFactory)
static @NotNull SpecReader	createAndReadExamples(@NotNull ResourceLocation location, boolean compoundSections)
static <S extends SpecReader> S	createAndReadExamples(@NotNull ResourceLocation location, @NotNull SpecReaderFactory<S> readerFactory)
@NotNull List<SpecExample>	getExamples()
@NotNull List<String>	getExamplesSourceAsString()
@NotNull String	getFileUrl()
@NotNull ResourceLocation	getResourceLocation()
protected void	processLine(String line)
void	readExamples()
protected void	resetContents()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXAMPLE_KEYWORD

public static final String EXAMPLE_KEYWORD

See Also:

• Constant Field Values

EXAMPLE_BREAK

public static final String EXAMPLE_BREAK

See Also:

• Constant Field Values

EXAMPLE_START

public static final String EXAMPLE_START

See Also:

• Constant Field Values

EXAMPLE_START_NBSP

public static final String EXAMPLE_START_NBSP

See Also:

• Constant Field Values

EXAMPLE_TEST_BREAK

public static final String EXAMPLE_TEST_BREAK

See Also:

• Constant Field Values

EXAMPLE_TEST_START

public static final String EXAMPLE_TEST_START

See Also:

• Constant Field Values

OPTIONS_KEYWORD

public static final String OPTIONS_KEYWORD

See Also:

• Constant Field Values

OPTIONS_STRING

public static final String OPTIONS_STRING

See Also:

• Constant Field Values

OPTIONS_PATTERN

public static final Pattern OPTIONS_PATTERN

SECTION_BREAK

public static final String SECTION_BREAK

See Also:

• Constant Field Values

SECTION_TEST_BREAK

public static final String SECTION_TEST_BREAK

See Also:

• Constant Field Values

SECTION_PATTERN

protected static final Pattern SECTION_PATTERN

inputStream

@NotNull
protected final @NotNull InputStream inputStream

resourceLocation

@NotNull
protected final @NotNull ResourceLocation resourceLocation

compoundSections

protected final boolean compoundSections

examples

protected final List<SpecExample> examples

sections

protected final String[] sections

lastSectionLevel

protected int lastSectionLevel

state

protected SpecReader.State state

section

protected String section

optionsSet

protected String optionsSet

source

protected StringBuilder source

html

protected StringBuilder html

ast

protected StringBuilder ast

comment

protected StringBuilder comment

exampleNumber

protected int exampleNumber

lineNumber

protected int lineNumber

contentLineNumber

protected int contentLineNumber

commentLineNumber

protected int commentLineNumber

Constructor Details

SpecReader

public SpecReader(@NotNull
 @NotNull InputStream stream,
 @NotNull
 @NotNull ResourceLocation location,
 boolean compoundSections)

Method Details

getFileUrl

@NotNull
public @NotNull String getFileUrl()

getResourceLocation

@NotNull
public @NotNull ResourceLocation getResourceLocation()

getExamples

@NotNull
public @NotNull List<SpecExample> getExamples()

getExamplesSourceAsString

@NotNull
public @NotNull List<String> getExamplesSourceAsString()

create

@NotNull
public static @NotNull SpecReader create(@NotNull
 @NotNull ResourceLocation location,
 boolean compoundSections)

create

@NotNull
public static <S extends SpecReader> S create(@NotNull
 @NotNull ResourceLocation location,
 @NotNull
 @NotNull SpecReaderFactory<S> readerFactory)

createAndReadExamples

@NotNull
public static @NotNull SpecReader createAndReadExamples(@NotNull
 @NotNull ResourceLocation location,
 boolean compoundSections)

createAndReadExamples

@NotNull
public static <S extends SpecReader> S createAndReadExamples(@NotNull
 @NotNull ResourceLocation location,
 @NotNull
 @NotNull SpecReaderFactory<S> readerFactory)

readExamples

public void readExamples()

addSpecLine

protected void addSpecLine(String line,
 boolean isSpecExampleOpen)

addSpecExample

protected void addSpecExample(@NotNull
 @NotNull SpecExample example)

processLine

protected void processLine(String line)

resetContents

protected void resetContents()