com.credibledoc.substitution.doc.plantuml

Enum Participant

java.lang.Object

java.lang.Enum<Participant>

com.credibledoc.substitution.doc.plantuml.Participant

All Implemented Interfaces:

Serializable, Comparable<Participant>

public enum Participant
extends Enum<Participant>

PlantUML participants, for example SUBSTITUTION_DOC.

Author:

Kyrylo Semenko

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUBSTITUTION_CORE The substitution module.
SUBSTITUTION_DOC This module.

Field Summary

Fields

Modifier and Type	Field and Description
private String	uml A name in a diagram

Method Summary

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

SUBSTITUTION_CORE

public static final Participant SUBSTITUTION_CORE

The substitution module.

SUBSTITUTION_DOC

public static final Participant SUBSTITUTION_DOC

This module.

Field Detail

uml

private final String uml

A name in a diagram

Method Detail

values

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

Returns:

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

valueOf

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

getUml

public String getUml()

Returns:

The uml field