io.smallrye.openapi.ui

Enum DocExpansion

java.lang.Object

java.lang.Enum<DocExpansion>

io.smallrye.openapi.ui.DocExpansion

All Implemented Interfaces:

Serializable, Comparable<DocExpansion>

public enum DocExpansion
extends Enum<DocExpansion>

Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Enum Constant Summary

Enum Constants

Enum Constant and Description
full
list
none

Method Summary

Modifier and Type	Method and Description
static DocExpansion	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocExpansion[]	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

list

public static final DocExpansion list

full

public static final DocExpansion full

none

public static final DocExpansion none

Method Detail

values

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

Returns:

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

valueOf

public static DocExpansion 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