Class SkipSection

java.lang.Object

org.opensearch.test.rest.yaml.section.SkipSection

public class SkipSection
extends Object

Represents a skip section that tells whether a specific test section or suite needs to be skipped based on: - the opensearch version the tests are running against - a specific test feature required that might not be implemented yet by the runner

Field Summary

Fields

Modifier and Type	Field	Description
static final SkipSection	EMPTY

Constructor Summary

Constructors

Constructor	Description
SkipSection(String versionRange, List<String> features, String reason)

Method Summary

Modifier and Type	Method	Description
List<String>	getFeatures()
org.opensearch.Version	getLowerVersion()
String	getReason()
String	getSkipMessage(String description)
org.opensearch.Version	getUpperVersion()
boolean	isEmpty()
boolean	isVersionCheck()
static SkipSection	parse(org.opensearch.core.xcontent.XContentParser parser)
static SkipSection	parseIfNext(org.opensearch.core.xcontent.XContentParser parser)	Parse a SkipSection if the next field is skip, otherwise returns EMPTY.
boolean	skip(org.opensearch.Version currentVersion)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final SkipSection EMPTY

Constructor Details

SkipSection

public SkipSection(String versionRange,
 List<String> features,
 String reason)

Method Details

parseIfNext

public static SkipSection parseIfNext(org.opensearch.core.xcontent.XContentParser parser)
                               throws IOException

Parse a SkipSection if the next field is skip, otherwise returns EMPTY.

Throws:

IOException

parse

public static SkipSection parse(org.opensearch.core.xcontent.XContentParser parser)
                         throws IOException

Throws:

IOException

getLowerVersion

public org.opensearch.Version getLowerVersion()

getUpperVersion

public org.opensearch.Version getUpperVersion()

getFeatures

public List<String> getFeatures()

getReason

public String getReason()

skip

public boolean skip(org.opensearch.Version currentVersion)

isVersionCheck

public boolean isVersionCheck()

isEmpty

public boolean isEmpty()

getSkipMessage

public String getSkipMessage(String description)