MarkdownParsingSubmode Class

public final class MarkdownParsingSubmode
extends ExpandableStringEnum<MarkdownParsingSubmode>

Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`.

Field Summary

Modifier and Type Field and Description
static final MarkdownParsingSubmode ONE_TO_MANY

Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents.

static final MarkdownParsingSubmode ONE_TO_ONE

Indicates that each markdown file will be parsed into a single search document.

Constructor Summary

Constructor Description
MarkdownParsingSubmode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of MarkdownParsingSubmode value.

Method Summary

Modifier and Type Method and Description
static MarkdownParsingSubmode fromString(String name)

Creates or finds a MarkdownParsingSubmode from its string representation.

static Collection<MarkdownParsingSubmode> values()

Gets known MarkdownParsingSubmode values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

ONE_TO_MANY

public static final MarkdownParsingSubmode ONE_TO_MANY

Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode.

ONE_TO_ONE

public static final MarkdownParsingSubmode ONE_TO_ONE

Indicates that each markdown file will be parsed into a single search document.

Constructor Details

MarkdownParsingSubmode

@Deprecated
public MarkdownParsingSubmode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of MarkdownParsingSubmode value.

Method Details

fromString

public static MarkdownParsingSubmode fromString(String name)

Creates or finds a MarkdownParsingSubmode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding MarkdownParsingSubmode.

values

public static Collection<MarkdownParsingSubmode> values()

Gets known MarkdownParsingSubmode values.

Returns:

known MarkdownParsingSubmode values.

Applies to