org.springframework.graphql.web

Class WebOutput

java.lang.Object

org.springframework.graphql.web.WebOutput

All Implemented Interfaces:

ExecutionResult

public class WebOutput
extends Object
implements ExecutionResult

Decorate an ExecutionResult, provide a way to transform it, and collect input for custom HTTP response headers for GraphQL over HTTP requests.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebOutput.Builder Builder to transform a WebOutput.

Constructor Summary

Constructors

Constructor and Description
WebOutput(WebInput input, ExecutionResult executionResult) Create an instance that wraps the given ExecutionResult.

Method Summary

Modifier and Type	Method and Description
<T> T	getData()
List<GraphQLError>	getErrors()
Map<Object,Object>	getExtensions()
HttpHeaders	getResponseHeaders() Return a read-only view of any custom headers to be added to the HTTP response, or null until transform(Consumer) is used to add such headers.
WebInput	getWebInput() Return the associated WebInput used for the execution.
boolean	isDataPresent()
Map<String,Object>	toSpecification()
WebOutput	transform(Consumer<WebOutput.Builder> consumer) Transform this WebOutput instance through a WebOutput.Builder and return a new instance with the modified values.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebOutput

public WebOutput(WebInput input,
                 ExecutionResult executionResult)

Create an instance that wraps the given ExecutionResult.

Parameters:

input - the container for the GraphQL input

executionResult - the result of performing a graphql query

Method Detail

getWebInput

public WebInput getWebInput()

Return the associated WebInput used for the execution.

Returns:

the associated WebInput

getData

@Nullable
public <T> T getData()

Specified by:

getData in interface ExecutionResult

isDataPresent

public boolean isDataPresent()

Specified by:

isDataPresent in interface ExecutionResult

getErrors

public List<GraphQLError> getErrors()

Specified by:

getErrors in interface ExecutionResult

getExtensions

@Nullable
public Map<Object,Object> getExtensions()

Specified by:

getExtensions in interface ExecutionResult

toSpecification

public Map<String,Object> toSpecification()

Specified by:

toSpecification in interface ExecutionResult

getResponseHeaders

@Nullable
public HttpHeaders getResponseHeaders()

Return a read-only view of any custom headers to be added to the HTTP response, or null until transform(Consumer) is used to add such headers.

Returns:

the read-only HTTP response headers

See Also:

transform(Consumer), WebOutput.Builder.responseHeader(String, String...)

transform

public WebOutput transform(Consumer<WebOutput.Builder> consumer)

Transform this WebOutput instance through a WebOutput.Builder and return a new instance with the modified values.

Parameters:

consumer - teh callback that will transform the WebOutput

Returns:

the transformed WebOutput