Package com.github.muehmar.gradle.openapi.generator.model

Class EnumMember

java.lang.Object

com.github.muehmar.gradle.openapi.generator.model.EnumMember

public class EnumMember
extends Object

An enum member containing the name itself and optionally a description.

Constructor Summary

Constructors

Constructor	Description
EnumMember(EnumConstantName name, String description)

Method Summary

Modifier and Type	Method	Description
static Optional<EnumMember>	extractDescription(EnumConstantName memberName, EnumDescriptionSettings settings, String description)
static PList<EnumMember>	extractDescriptions(PList<EnumConstantName> enumMembers, EnumDescriptionSettings settings, String description)	Returns a list of enums with found description.
String	getDescription()
EnumConstantName	getName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnumMember

public EnumMember(EnumConstantName name,
 String description)

Method Details

extractDescription

public static Optional<EnumMember> extractDescription(EnumConstantName memberName,
 EnumDescriptionSettings settings,
 String description)

extractDescriptions

public static PList<EnumMember> extractDescriptions(PList<EnumConstantName> enumMembers,
 EnumDescriptionSettings settings,
 String description)

Returns a list of enums with found description. If no description is found, the description will be set to an empty string in case failOnIncompleteDescriptions is turned off. In case it is turned on, this method will fail if a description of a member is not found.

getName

public EnumConstantName getName()

getDescription

public String getDescription()