Class ComboSpecTestCase

java.lang.Object

com.vladsch.flexmark.test.util.RenderingTestCase

com.vladsch.flexmark.test.util.FullSpecTestCase

com.vladsch.flexmark.test.util.ComboSpecTestCase

All Implemented Interfaces:

SpecExampleProcessor

Direct Known Subclasses:

FormatterTranslationSpecTestBase, RendererSpecTest

public abstract class ComboSpecTestCase
extends FullSpecTestCase

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<BiFunction<String, String, DataHolder>>	CUSTOM_OPTION
protected final @NotNull SpecExample	example
protected final @Nullable DataHolder	myDefaultOptions
protected final @NotNull Map<String, DataHolder>	optionsMap

Fields inherited from class RenderingTestCase

EMBED_TIMED, EXTENSIONS, FAIL, IGNORE, INCLUDED_DOCUMENT, LOAD_EXTENSIONS, NO_FILE_EOL, NO_FILE_EOL_FALSE, SOURCE_INDENT, SOURCE_PREFIX, SOURCE_SUFFIX, thrown, TIMED, TIMED_ITERATIONS, UNLOAD_EXTENSIONS

Constructor Summary

Constructors

Constructor	Description
ComboSpecTestCase(@NotNull SpecExample example, @Nullable Map<String, ? extends DataHolder> optionMap, @Nullable DataHolder... defaultOptions)

Method Summary

Modifier and Type	Method	Description
static @NotNull DataHolder	aggregate(@Nullable DataHolder other, @Nullable DataHolder overrides)
protected boolean	compoundSections()
static @Nullable DataHolder[]	dataHolders(@Nullable DataHolder other, @Nullable DataHolder[] overrides)
protected final @NotNull ResourceLocation	getSpecResourceLocation()
protected static @NotNull List<Object[]>	getTestData(@NotNull ResourceLocation location)
@Nullable DataHolder	options(@NotNull String option)	Customize options for an example
static @Nullable Map<String, ? extends DataHolder>	optionsMaps(@Nullable Map<String, ? extends DataHolder> other, @Nullable Map<String, ? extends DataHolder> overrides)
static @NotNull Map<String, DataHolder>	placementAndSortOptions(@Nullable DataKey<KeepType> keepTypeDataKey, @Nullable DataKey<ElementPlacement> placementDataKey, @Nullable DataKey<ElementPlacementSort> sortDataKey)
static @NotNull Map<String, DataHolder>	placementAndSortOptions(DataKey<ElementPlacement> placementDataKey, DataKey<ElementPlacementSort> sortDataKey)
void	testSpecExample()

Methods inherited from class FullSpecTestCase

create, fullTestSpecComplete, fullTestSpecStarting

Methods inherited from class RenderingTestCase

addFullSpecExample, addSpecExample, assertRendering, assertRendering, assertRendering

Methods inherited from class Object

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

Methods inherited from interface SpecExampleProcessor

addFullSpecExample, checkExample, getSpecExampleRenderer

Field Details

CUSTOM_OPTION

public static final DataKey<BiFunction<String, String, DataHolder>> CUSTOM_OPTION

example

@NotNull
protected final @NotNull SpecExample example

optionsMap

@NotNull
protected final @NotNull Map<String, DataHolder> optionsMap

myDefaultOptions

@Nullable
protected final @Nullable DataHolder myDefaultOptions

Constructor Details

ComboSpecTestCase

public ComboSpecTestCase(@NotNull
 @NotNull SpecExample example,
 @Nullable
 @Nullable Map<String, ? extends DataHolder> optionMap,
 @Nullable
 @Nullable DataHolder... defaultOptions)

Method Details

placementAndSortOptions

@NotNull
public static @NotNull Map<String, DataHolder> placementAndSortOptions(DataKey<ElementPlacement> placementDataKey,
 DataKey<ElementPlacementSort> sortDataKey)

placementAndSortOptions

@NotNull
public static @NotNull Map<String, DataHolder> placementAndSortOptions(@Nullable
 @Nullable DataKey<KeepType> keepTypeDataKey,
 @Nullable
 @Nullable DataKey<ElementPlacement> placementDataKey,
 @Nullable
 @Nullable DataKey<ElementPlacementSort> sortDataKey)

compoundSections

protected boolean compoundSections()

Overrides:

compoundSections in class FullSpecTestCase

optionsMaps

@Nullable
public static @Nullable Map<String, ? extends DataHolder> optionsMaps(@Nullable
 @Nullable Map<String, ? extends DataHolder> other,
 @Nullable
 @Nullable Map<String, ? extends DataHolder> overrides)

dataHolders

@Nullable
public static @Nullable DataHolder[] dataHolders(@Nullable
 @Nullable DataHolder other,
 @Nullable
 @Nullable DataHolder[] overrides)

aggregate

@NotNull
public static @NotNull DataHolder aggregate(@Nullable
 @Nullable DataHolder other,
 @Nullable
 @Nullable DataHolder overrides)

options

@Nullable
public @Nullable DataHolder options(@NotNull
 @NotNull String option)

Description copied from interface: SpecExampleProcessor

Customize options for an example

Parameters:

option - name of the options set to use

Returns:

options or null to use default

getSpecResourceLocation

@NotNull
protected final @NotNull ResourceLocation getSpecResourceLocation()

Specified by:

getSpecResourceLocation in class FullSpecTestCase

testSpecExample

public void testSpecExample()

Overrides:

testSpecExample in class FullSpecTestCase

getTestData

@NotNull
protected static @NotNull List<Object[]> getTestData(@NotNull
 @NotNull ResourceLocation location)