org.springframework.graphql.data.method.annotation

Annotation Type LocalContextValue

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

Annotation to bind a method parameter to an attribute from the local GraphQLContext.

To bind to an attribute from the main context instead, see @ContextValue.

Since:

1.0.0

Author:

Rossen Stoyanchev

See Also:

ContextValue

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