FilesExpand file tree

 master

/

GraphqlErrorBuilder.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

156 lines (129 loc) · 4.6 KB

 master

/

GraphqlErrorBuilder.java

Copy path

Top

File metadata and controls

• Code
• Blame

156 lines (129 loc) · 4.6 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

package graphql;

import graphql.execution.DataFetcherResult;

import graphql.execution.ResultPath;

import graphql.language.SourceLocation;

import graphql.schema.DataFetchingEnvironment;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import static graphql.Assert.assertNotNull;

/**

* This helps you build {@link graphql.GraphQLError}s and also has a quick way to make a {@link graphql.execution.DataFetcherResult}s

* from that error.

*/

@PublicApi

public class GraphqlErrorBuilder {

private String message;

private List<Object> path;

private List<SourceLocation> locations = new ArrayList<>();

private ErrorClassification errorType = ErrorType.DataFetchingException;

private Map<String, Object> extensions = null;

/**

* @return a builder of {@link graphql.GraphQLError}s

*/

public static GraphqlErrorBuilder newError() {

return new GraphqlErrorBuilder();

}

/**

* This will set up the {@link GraphQLError#getLocations()} and {@link graphql.GraphQLError#getPath()} for you from the

* fetching environment.

*

* @param dataFetchingEnvironment the data fetching environment

*

* @return a builder of {@link graphql.GraphQLError}s

*/

public static GraphqlErrorBuilder newError(DataFetchingEnvironment dataFetchingEnvironment) {

return new GraphqlErrorBuilder()

.location(dataFetchingEnvironment.getField().getSourceLocation())

.path(dataFetchingEnvironment.getExecutionStepInfo().getPath());

}

private GraphqlErrorBuilder() {

}

public GraphqlErrorBuilder message(String message, Object... formatArgs) {

if (formatArgs == null || formatArgs.length == 0) {

this.message = assertNotNull(message);

} else {

this.message = String.format(assertNotNull(message), formatArgs);

}

return this;

}

public GraphqlErrorBuilder locations(List<SourceLocation> locations) {

this.locations.addAll(assertNotNull(locations));

return this;

}

public GraphqlErrorBuilder location(SourceLocation location) {

this.locations.add(assertNotNull(location));

return this;

}

public GraphqlErrorBuilder path(ResultPath path) {

this.path = assertNotNull(path).toList();

return this;

}

public GraphqlErrorBuilder path(List<Object> path) {

this.path = assertNotNull(path);

return this;

}

public GraphqlErrorBuilder errorType(ErrorClassification errorType) {

this.errorType = assertNotNull(errorType);

return this;

}

public GraphqlErrorBuilder extensions(Map<String, Object> extensions) {

this.extensions = assertNotNull(extensions);

return this;

}

/**

* @return a newly built GraphqlError

*/

public GraphQLError build() {

assertNotNull(message, () -> "You must provide error message");

return new GraphqlErrorImpl(message, locations, errorType, path, extensions);

}

private static class GraphqlErrorImpl implements GraphQLError {

private final String message;

private final List<SourceLocation> locations;

private final ErrorClassification errorType;

private final List<Object> path;

private final Map<String, Object> extensions;

public GraphqlErrorImpl(String message, List<SourceLocation> locations, ErrorClassification errorType, List<Object> path, Map<String, Object> extensions) {

this.message = message;

this.locations = locations;

this.errorType = errorType;

this.path = path;

this.extensions = extensions;

}

@Override

public String getMessage() {

return message;

}

@Override

public List<SourceLocation> getLocations() {

return locations;

}

@Override

public ErrorClassification getErrorType() {

return errorType;

}

@Override

public List<Object> getPath() {

return path;

}

@Override

public Map<String, Object> getExtensions() {

return extensions;

}

@Override

public String toString() {

return message;

}

}

/**

* A helper method that allows you to return this error as a {@link graphql.execution.DataFetcherResult}

*

* @return a new data fetcher result that contains the built error

*/

public DataFetcherResult toResult() {

return DataFetcherResult.newResult()

.error(build())

.build();

}

}