com.boomi.connector.openapi.util

Enum OpenAPIComponent

java.lang.Object

java.lang.Enum<OpenAPIComponent>

com.boomi.connector.openapi.util.OpenAPIComponent

All Implemented Interfaces:

Serializable, Comparable<OpenAPIComponent>

public enum OpenAPIComponent
extends Enum<OpenAPIComponent>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALLBACKS
EXAMPLES
HEADERS
LINKS
PARAMETERS
REQUESTBODIES
RESPONSES
SCHEMAS
SECURITYSCHEMES

Field Summary

Fields

Modifier and Type	Field and Description
static String	VALID_COMPONENTS

Method Summary

Modifier and Type	Method and Description
String	getComponentTypeLabel() Returns the component type label as defined by the OpenAPI 3.0 Specification
static boolean	isReferenceComponentValid(String reference) Returns true if the references being validated matches the OpenAPI component structure of '#/components//', returns false otherwise.
static OpenAPIComponent	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpenAPIComponent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCHEMAS

public static final OpenAPIComponent SCHEMAS

REQUESTBODIES

public static final OpenAPIComponent REQUESTBODIES

PARAMETERS

public static final OpenAPIComponent PARAMETERS

SECURITYSCHEMES

public static final OpenAPIComponent SECURITYSCHEMES

RESPONSES

public static final OpenAPIComponent RESPONSES

HEADERS

public static final OpenAPIComponent HEADERS

EXAMPLES

public static final OpenAPIComponent EXAMPLES

LINKS

public static final OpenAPIComponent LINKS

CALLBACKS

public static final OpenAPIComponent CALLBACKS

Field Detail

VALID_COMPONENTS

public static final String VALID_COMPONENTS

Method Detail

values

public static OpenAPIComponent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OpenAPIComponent c : OpenAPIComponent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OpenAPIComponent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getComponentTypeLabel

public String getComponentTypeLabel()

Returns the component type label as defined by the OpenAPI 3.0 Specification

Returns:

the componentTypeLabel

isReferenceComponentValid

public static boolean isReferenceComponentValid(String reference)

Returns true if the references being validated matches the OpenAPI component structure of '#/components//', returns false otherwise.

Parameters:

reference -

Returns:

true if reference is valid, false otherwise