FilesExpand file tree

master

/

CollectionFormat.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

90 lines (85 loc) · 3.08 KB

master

/

CollectionFormat.java

Copy path

Top

File metadata and controls

• Code
• Blame

90 lines (85 loc) · 3.08 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

/*

* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

package feign;

import feign.template.UriUtils;

import java.nio.charset.Charset;

import java.util.Collection;

/**

* Various ways to encode collections in URL parameters.

*

* <p>These specific cases are inspired by the <a href="http://swagger.io/specification/">OpenAPI

* specification</a>.

*/

public enum CollectionFormat {

/** Comma separated values, eg foo=bar,baz */

CSV(","),

/** Space separated values, eg foo=bar baz */

SSV(" "),

/** Tab separated values, eg foo=bar[tab]baz */

TSV("\t"),

/** Values separated with the pipe (|) character, eg foo=bar|baz */

PIPES("|"),

/** Parameter name repeated for each value, eg foo=bar&foo=baz */

// Using null as a special case since there is no single separator character

EXPLODED(null);

private final String separator;

CollectionFormat(String separator) {

this.separator = separator;

}

/**

* Joins the field and possibly multiple values with the given separator.

*

* <p>Calling EXPLODED.join("foo", ["bar"]) will return "foo=bar".

*

* <p>Calling CSV.join("foo", ["bar", "baz"]) will return "foo=bar,baz".

*

* <p>Null values are treated somewhat specially. With EXPLODED, the field is repeated without any

* "=" for backwards compatibility. With all other formats, null values are not included in the

* joined value list.

*

* @param field The field name corresponding to these values.

* @param values A collection of value strings for the given field.

* @param charset to encode the sequence

* @return The formatted char sequence of the field and joined values. If the value collection is

* empty, an empty char sequence will be returned.

*/

public CharSequence join(String field, Collection<String> values, Charset charset) {

StringBuilder builder = new StringBuilder();

int valueCount = 0;

for (String value : values) {

if (separator == null) {

// exploded

builder.append(valueCount++ == 0 ? "" : "&");

builder.append(UriUtils.encode(field, charset));

if (value != null) {

builder.append('=');

builder.append(value);

}

} else {

// delimited with a separator character

if (builder.length() == 0) {

builder.append(UriUtils.encode(field, charset));

}

if (value == null) {

continue;

}

builder.append(valueCount++ == 0 ? "=" : UriUtils.encode(separator, charset));

builder.append(value);

}

}

return builder;

}

}