Module rxmicro.documentation

Package io.rxmicro.documentation

Enum IntroductionDefinition.Section

java.lang.Object

java.lang.Enum<IntroductionDefinition.Section>

io.rxmicro.documentation.IntroductionDefinition.Section

All Implemented Interfaces:

Serializable, Comparable<IntroductionDefinition.Section>

Enclosing class:

IntroductionDefinition

public static enum IntroductionDefinition.Section
extends Enum<IntroductionDefinition.Section>

Supported section types

Since:

0.1

Author:

nedis

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE_ENDPOINT	base endpoint standard section
COMMON_CONCEPT	Common concept standard section
CUSTOM_SECTION	Custom section.
ERROR_MODEL	Error model standard section
HANDLER_NOT_FOUND	`Handler not found` standard section
HTTP_VERBS	HTTP verbs standard section
LICENSES	Licences standard section
SPECIFICATION	Specification standard section

Method Summary

Modifier and Type	Method	Description
boolean	isCustomSection()	Returns true if current section is custom.
static IntroductionDefinition.Section	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IntroductionDefinition.Section[]	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

COMMON_CONCEPT

public static final IntroductionDefinition.Section COMMON_CONCEPT

Common concept standard section

BASE_ENDPOINT

public static final IntroductionDefinition.Section BASE_ENDPOINT

base endpoint standard section

HTTP_VERBS

public static final IntroductionDefinition.Section HTTP_VERBS

HTTP verbs standard section

ERROR_MODEL

public static final IntroductionDefinition.Section ERROR_MODEL

Error model standard section

HANDLER_NOT_FOUND

public static final IntroductionDefinition.Section HANDLER_NOT_FOUND

`Handler not found` standard section

LICENSES

public static final IntroductionDefinition.Section LICENSES

Licences standard section

SPECIFICATION

public static final IntroductionDefinition.Section SPECIFICATION

Specification standard section

CUSTOM_SECTION

public static final IntroductionDefinition.Section CUSTOM_SECTION

Custom section. If CUSTOM_SECTION is added to IntroductionDefinition.sectionOrder() it is necessary to add path to custom section to IntroductionDefinition.customSection(). Otherwise the RxMicro framework throws error during generation of REST-based microservice documentation.

Method Detail

values

public static IntroductionDefinition.Section[] 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 (IntroductionDefinition.Section c : IntroductionDefinition.Section.values())
    System.out.println(c);

Returns:

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

valueOf

public static IntroductionDefinition.Section 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

isCustomSection

public boolean isCustomSection()

Returns true if current section is custom.

Returns:

true if current section is custom.