Module rxmicro.documentation

Package io.rxmicro.documentation

Enum ResourceGroupDefinition.Section

java.lang.Object

java.lang.Enum<ResourceGroupDefinition.Section>

io.rxmicro.documentation.ResourceGroupDefinition.Section

All Implemented Interfaces:

Serializable, Comparable<ResourceGroupDefinition.Section>

Enclosing class:

ResourceGroupDefinition

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

Supported section types

Since:

0.1

Author:

nedis

Enum Constant Summary

Enum Constants

Enum Constant	Description
CORS	CORS standard section
CUSTOM_SECTION	Custom section.
VERSIONING	Versioning standard section

Method Summary

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

VERSIONING

public static final ResourceGroupDefinition.Section VERSIONING

Versioning standard section

CORS

public static final ResourceGroupDefinition.Section CORS

CORS standard section

CUSTOM_SECTION

public static final ResourceGroupDefinition.Section CUSTOM_SECTION

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

Method Detail

values

public static ResourceGroupDefinition.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 (ResourceGroupDefinition.Section c : ResourceGroupDefinition.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 ResourceGroupDefinition.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.