Top Fields Constructors Methods
com.vladsch.flexmark.test.util.spec

public Class SpecExample

extends Object
Class Inheritance
Imports
com.vladsch.flexmark.test.util.TestUtils, com.vladsch.flexmark.util.misc.Utils, org.jetbrains.annotations.NotNull, .Nullable, java.io.File, java.net.URL, java.util.Objects, java.util.concurrent.ConcurrentHashMap, .ConcurrentMap

Field Summary

Modifier and TypeField and Description
private final @Nullable String
private static final ConcurrentMap<String, String>
private final @Nullable String
private final int
private final @NotNull String
private final boolean
private final int
public static final SpecExample
private final @Nullable String
private final @NotNull ResourceLocation
private final @Nullable String
private final @NotNull String

Constructor Summary

AccessConstructor and Description
public
SpecExample(@NotNull ResourceLocation resourceLocation, int lineNumber, @Nullable String optionsSet, @Nullable String section, int exampleNumber, @NotNull String source, @NotNull String html, @Nullable String ast, String comment)

private
SpecExample(@NotNull ResourceLocation resourceLocation, int lineNumber, @Nullable String optionsSet, @Nullable String section, int exampleNumber, @NotNull String source, @NotNull String html, @Nullable String ast, String comment, boolean isNull)

Method Summary

Modifier and TypeMethod and Description
public @Nullable String
public @Nullable String
public int
public @NotNull String
public @NotNull String
public @NotNull String
getFileUrlWithLineNumber(int lineOffset)

public @NotNull String
public @Nullable String
public @NotNull ResourceLocation
public @Nullable String
public @NotNull String
public boolean
public boolean
public boolean
public boolean
public boolean
public static @NotNull SpecExample
ofCaller(int callNesting, Class<?> resourceClass, @NotNull String source, @NotNull String html, @Nullable String ast)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public SpecExample
public SpecExample
withExampleNumber(int exampleNumber)

public SpecExample
public SpecExample
public SpecExample
public SpecExample
public SpecExample
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

astback to summary
private final @Nullable String ast
Annotations
@Nullable
classMapback to summary
private static final ConcurrentMap<String, String> classMap
commentback to summary
private final @Nullable String comment
Annotations
@Nullable
exampleNumberback to summary
private final int exampleNumber
htmlback to summary
private final @NotNull String html
Annotations
@NotNull
isNullback to summary
private final boolean isNull
lineNumberback to summary
private final int lineNumber
NULLback to summary
public static final SpecExample NULL
optionsSetback to summary
private final @Nullable String optionsSet
Annotations
@Nullable
resourceLocationback to summary
private final @NotNull ResourceLocation resourceLocation
Annotations
@NotNull
sectionback to summary
private final @Nullable String section
Annotations
@Nullable
sourceback to summary
private final @NotNull String source
Annotations
@NotNull

Constructor Detail

SpecExampleback to summary
public SpecExample(@NotNull ResourceLocation resourceLocation, int lineNumber, @Nullable String optionsSet, @Nullable String section, int exampleNumber, @NotNull String source, @NotNull String html, @Nullable String ast, String comment)
SpecExampleback to summary
private SpecExample(@NotNull ResourceLocation resourceLocation, int lineNumber, @Nullable String optionsSet, @Nullable String section, int exampleNumber, @NotNull String source, @NotNull String html, @Nullable String ast, String comment, boolean isNull)

Method Detail

getAstback to summary
public @Nullable String getAst()
Annotations
@Nullable
getCommentback to summary
public @Nullable String getComment()
Annotations
@Nullable
getExampleNumberback to summary
public int getExampleNumber()
getFileUrlback to summary
public @NotNull String getFileUrl()
Annotations
@NotNull
getFileUrlWithLineNumberback to summary
public @NotNull String getFileUrlWithLineNumber()
Annotations
@NotNull
getFileUrlWithLineNumberback to summary
public @NotNull String getFileUrlWithLineNumber(int lineOffset)
Annotations
@NotNull
getHtmlback to summary
public @NotNull String getHtml()
Annotations
@NotNull
getOptionsSetback to summary
public @Nullable String getOptionsSet()
Annotations
@Nullable
getResourceLocationback to summary
public @NotNull ResourceLocation getResourceLocation()
Annotations
@NotNull
getSectionback to summary
public @Nullable String getSection()
Annotations
@Nullable
getSourceback to summary
public @NotNull String getSource()
Annotations
@NotNull
hasCommentback to summary
public boolean hasComment()
isFullSpecExampleback to summary
public boolean isFullSpecExample()
isNotNullback to summary
public boolean isNotNull()
isNullback to summary
public boolean isNull()
isSpecExampleback to summary
public boolean isSpecExample()
ofCallerback to summary
public static @NotNull SpecExample ofCaller(int callNesting, Class<?> resourceClass, @NotNull String source, @NotNull String html, @Nullable String ast)
Annotations
@NotNull
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
withAstback to summary
public SpecExample withAst(@Nullable String ast)
withExampleNumberback to summary
public SpecExample withExampleNumber(int exampleNumber)
withHtmlback to summary
public SpecExample withHtml(@NotNull String html)
withOptionsSetback to summary
public SpecExample withOptionsSet(@Nullable String optionsSet)
withResourceLocationback to summary
public SpecExample withResourceLocation(@NotNull ResourceLocation location)
withSectionback to summary
public SpecExample withSection(@Nullable String section)
withSourceback to summary
public SpecExample withSource(@NotNull String source)