forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDecoders.java
More file actions
138 lines (128 loc) · 5.04 KB
/
Decoders.java
File metadata and controls
138 lines (128 loc) · 5.04 KB
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
/*
* Copyright 2013 Netflix, Inc.
*
* 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.codec;
import com.google.common.base.Function;
import com.google.common.base.Functions;
import com.google.common.collect.ImmutableList;
import com.google.common.io.CharStreams;
import com.google.common.reflect.TypeToken;
import java.io.Reader;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static com.google.common.base.Preconditions.checkNotNull;
import static java.lang.String.format;
import static java.util.regex.Pattern.DOTALL;
import static java.util.regex.Pattern.compile;
/**
* Static utility methods pertaining to {@code Decoder} instances.
* <p/>
* <h4>Pattern Decoders</h4>
* <p/>
* Pattern decoders typically require less initialization, dependencies, and
* code than reflective decoders, but not can be awkward to those unfamiliar
* with regex. Typical use of pattern decoders is to grab a single field from an
* xml response, or parse a list of Strings. The pattern decoders here
* facilitate these use cases.
*/
public class Decoders {
/**
* The first match group is applied to {@code applyGroups} and result
* returned. If no matches are found, the response is null;
* <p/>
* Ex. to pull the first interesting element from an xml response:
* <p/>
* <pre>
* decodeFirstDirPoolID = transformFirstGroup("<DirPoolID[ˆ>]*>([ˆ<]+)</DirPoolID>", ToLong.INSTANCE);
* </pre>
*/
public static <T> Decoder transformFirstGroup(String pattern, final Function<String, T> applyFirstGroup) {
final Pattern patternForMatcher = compile(checkNotNull(pattern, "pattern"), DOTALL);
checkNotNull(applyFirstGroup, "applyFirstGroup");
return new Decoder() {
@Override
public Object decode(String methodKey, Reader reader, TypeToken<?> type) throws Throwable {
Matcher matcher = patternForMatcher.matcher(CharStreams.toString(reader));
if (matcher.find()) {
return applyFirstGroup.apply(matcher.group(1));
}
return null;
}
@Override public String toString() {
return format("decode groups from %s into %s", patternForMatcher, applyFirstGroup);
}
};
}
/**
* shortcut for {@link Decoders#transformFirstGroup(String, Function)} when
* {@code String} is the type you are decoding into.
* <p/>
* <p/>
* Ex. to pull the first interesting element from an xml response:
* <p/>
* <pre>
* decodeFirstDirPoolID = firstGroup("<DirPoolID[ˆ>]*>([ˆ<]+)</DirPoolID>");
* </pre>
*/
public static Decoder firstGroup(String pattern) {
return transformFirstGroup(pattern, Functions.<String>identity());
}
/**
* On the each find the first match group is applied to
* {@code applyFirstGroup} and added to the list returned. If no matches are
* found, the response is an empty list;
* <p/>
* Ex. to pull a list zones constructed from http paths starting with
* {@code /Rest/Zone/}:
* <p/>
* <pre>
* decodeListOfZones = transformEachFirstGroup("/REST/Zone/([ˆ/]+)/", ToZone.INSTANCE);
* </pre>
*/
public static <T> Decoder transformEachFirstGroup(String pattern, final Function<String, T> applyFirstGroup) {
final Pattern patternForMatcher = compile(checkNotNull(pattern, "pattern"), DOTALL);
checkNotNull(applyFirstGroup, "applyFirstGroup");
return new Decoder() {
@Override
public List<T> decode(String methodKey, Reader reader, TypeToken<?> type) throws Throwable {
Matcher matcher = patternForMatcher.matcher(CharStreams.toString(reader));
ImmutableList.Builder<T> builder = ImmutableList.<T>builder();
while (matcher.find()) {
builder.add(applyFirstGroup.apply(matcher.group(1)));
}
return builder.build();
}
@Override public String toString() {
return format("decode %s into list elements, where each group(1) is transformed with %s",
patternForMatcher, applyFirstGroup);
}
};
}
/**
* shortcut for {@link Decoders#transformEachFirstGroup(String, Function)}
* when {@code List<String>} is the type you are decoding into.
* <p/>
* Ex. to pull a list zones names, which are http paths starting with
* {@code /Rest/Zone/}:
* <p/>
* <pre>
* decodeListOfZonesNames = eachFirstGroup("/REST/Zone/([ˆ/]+)/");
* </pre>
*/
public static Decoder eachFirstGroup(String pattern) {
return transformEachFirstGroup(pattern, Functions.<String>identity());
}
}