org.springframework.graphql.data.method.annotation

Annotation Type ContextValue

@Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Documented
public @interface ContextValue

Annotation for method parameters obtained from one of the following:

• DataFetchingEnvironment.getLocalContext() -- if it is an instance of GraphQLContext.
• DataFetchingEnvironment.getGraphQlContext()

Since:

1.0.0

Author:

Rossen Stoyanchev

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name The name of the value to bind to.
boolean	required Whether the value is required.
String	value Alias for name().

Element Detail

value

@AliasFor(value="name")
public abstract String value

Alias for name().

Default:

""

name

@AliasFor(value="value")
public abstract String name

The name of the value to bind to.

Default:

""

required

public abstract boolean required

Whether the value is required.

Defaults to "true", leading to an exception thrown if the value is missing. Switch to "false" if you prefer null if the value is not present, or use Optional.

Default:

true