Package software.amazon.smithy.docgen.writers

Enum Class DocWriter.NoticeType

java.lang.Object

java.lang.Enum<DocWriter.NoticeType>

software.amazon.smithy.docgen.writers.DocWriter.NoticeType

All Implemented Interfaces:

Serializable, Comparable<DocWriter.NoticeType>, Constable

Enclosing class:

DocWriter

public static enum DocWriter.NoticeType
extends Enum<DocWriter.NoticeType>

The type of admonition.

This affects the default title of the admonition, as well as styling.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DANGER	A notice that adds context with extreme severity.
IMPORTANT	An notice that adds context which is important, but not severely so.
INFO	A notice that refers to external context or highlights information.
NOTE	An notice that adds context without any strong severity.
WARNING	A notice that adds context with strong severity.

Method Summary

Modifier and Type	Method	Description
static DocWriter.NoticeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocWriter.NoticeType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOTE

public static final DocWriter.NoticeType NOTE

An notice that adds context without any strong severity.

IMPORTANT

public static final DocWriter.NoticeType IMPORTANT

An notice that adds context which is important, but not severely so.

WARNING

public static final DocWriter.NoticeType WARNING

A notice that adds context with strong severity.

This might be used by deprecation notices or required badges, for example.

DANGER

public static final DocWriter.NoticeType DANGER

A notice that adds context with extreme severity.

This might be used to add information about security-related concerns, such as sensitive shapes and members.

INFO

public static final DocWriter.NoticeType INFO

A notice that refers to external context or highlights information.

Method Details

values

public static DocWriter.NoticeType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DocWriter.NoticeType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null