Package io.smallrye.graphql.api.federation.link

Enum Class Purpose

java.lang.Object

java.lang.Enum<Purpose>

io.smallrye.graphql.api.federation.link.Purpose

All Implemented Interfaces:

Serializable, Comparable<Purpose>, Constable

public enum Purpose
extends Enum<Purpose>

The role of a Link schema. This behavior is different for Link with a specified purpose:

• SECURITY links convey metadata necessary to compute the API schema and securely resolve fields within it
• EXECUTION links convey metadata necessary to correctly resolve fields within the schema
• UNDEFINED is used for internal purposes as the default value that should be ignored and not used in the schema

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
EXECUTION
SECURITY
UNDEFINED

Method Summary

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

SECURITY

@Description("`SECURITY` features provide metadata necessary to securely resolve fields.")
public static final Purpose SECURITY

EXECUTION

@Description("`EXECUTION` features provide metadata necessary for operation execution.")
public static final Purpose EXECUTION

UNDEFINED

@Ignore
public static final Purpose UNDEFINED

Method Details

values

public static Purpose[] 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 Purpose 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