Skip to content

Commit d5389a5

Browse files
cezar-techvelo
cezar-tech
authored and
velo
committed
Fixes a typo in Contract.java method (OpenFeign#1098)
* The method parseAndValidatateMetadata has been deleted and parseAndValidateMetadata is used instead; * Replaced all usages along the project; * Documented which method to use instead of the deleted one. Signed-off-by: Cézar Augusto <[email protected]>
1 parent 76a4524 commit d5389a5

9 files changed

Lines changed: 36 additions & 33 deletions

File tree

‎benchmark/src/main/java/feign/benchmark/WhatShouldWeCacheBenchmarks.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ public void setup() {
5656
feignContract = new Contract.Default();
5757
cachedContact = new Contract() {
5858
private final List<MethodMetadata> cached =
59-
new Default().parseAndValidatateMetadata(FeignTestInterface.class);
59+
new Default().parseAndValidateMetadata(FeignTestInterface.class);
6060

61-
public List<MethodMetadata> parseAndValidatateMetadata(Class<?> declaring) {
61+
public List<MethodMetadata> parseAndValidateMetadata(Class<?> declaring) {
6262
return cached;
6363
}
6464
};
@@ -84,7 +84,7 @@ public Response execute(Request request, Request.Options options) throws IOExcep
8484
*/
8585
@Benchmark
8686
public List<MethodMetadata> parseFeignContract() {
87-
return feignContract.parseAndValidatateMetadata(FeignTestInterface.class);
87+
return feignContract.parseAndValidateMetadata(FeignTestInterface.class);
8888
}
8989

9090
/**

‎core/src/main/java/feign/Contract.java‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,16 @@ public interface Contract {
3333
*
3434
* @param targetType {@link feign.Target#type() type} of the Feign interface.
3535
*/
36-
// TODO: break this and correct spelling at some point
37-
List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType);
36+
List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType);
3837

3938
abstract class BaseContract implements Contract {
4039

40+
/**
41+
* @param targetType {@link feign.Target#type() type} of the Feign interface.
42+
* @see #parseAndValidateMetadata(Class)
43+
*/
4144
@Override
42-
public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
45+
public List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType) {
4346
checkState(targetType.getTypeParameters().length == 0, "Parameterized types unsupported: %s",
4447
targetType.getSimpleName());
4548
checkState(targetType.getInterfaces().length <= 1, "Only single inheritance supported: %s",
@@ -68,12 +71,12 @@ public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
6871
* @deprecated use {@link #parseAndValidateMetadata(Class, Method)} instead.
6972
*/
7073
@Deprecated
71-
public MethodMetadata parseAndValidatateMetadata(Method method) {
74+
public MethodMetadata parseAndValidateMetadata(Method method) {
7275
return parseAndValidateMetadata(method.getDeclaringClass(), method);
7376
}
7477

7578
/**
76-
* Called indirectly by {@link #parseAndValidatateMetadata(Class)}.
79+
* Called indirectly by {@link #parseAndValidateMetadata(Class)}.
7780
*/
7881
protected MethodMetadata parseAndValidateMetadata(Class<?> targetType, Method method) {
7982
MethodMetadata data = new MethodMetadata();

‎core/src/main/java/feign/DeclarativeContract.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ public abstract class DeclarativeContract extends BaseContract {
3131
new HashMap<>();
3232

3333
@Override
34-
public final List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
34+
public final List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType) {
3535
// any implementations must register processors
36-
return super.parseAndValidatateMetadata(targetType);
36+
return super.parseAndValidateMetadata(targetType);
3737
}
3838

3939
/**

‎core/src/main/java/feign/ReflectiveFeign.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ static final class ParseHandlersByName {
151151
}
152152

153153
public Map<String, MethodHandler> apply(Target key) {
154-
List<MethodMetadata> metadata = contract.parseAndValidatateMetadata(key.type());
154+
List<MethodMetadata> metadata = contract.parseAndValidateMetadata(key.type());
155155
Map<String, MethodHandler> result = new LinkedHashMap<String, MethodHandler>();
156156
for (MethodMetadata md : metadata) {
157157
BuildTemplateByResolvingArgs buildTemplate;

‎core/src/test/java/feign/ContractWithRuntimeInjectionTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ static class ContractWithRuntimeInjection implements Contract {
9393
* Injects {@link MethodMetadata#indexToExpander(Map)} via {@link BeanFactory#getBean(Class)}.
9494
*/
9595
@Override
96-
public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
97-
List<MethodMetadata> result = new Contract.Default().parseAndValidatateMetadata(targetType);
96+
public List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType) {
97+
List<MethodMetadata> result = new Contract.Default().parseAndValidateMetadata(targetType);
9898
for (MethodMetadata md : result) {
9999
Map<Integer, Param.Expander> indexToExpander = new LinkedHashMap<Integer, Param.Expander>();
100100
for (Map.Entry<Integer, Class<? extends Param.Expander>> entry : md.indexToExpanderClass()

‎core/src/test/java/feign/DefaultContractTest.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ interface SimpleParameterizedApi extends SimpleParameterizedBaseApi<String> {
584584

585585
@Test
586586
public void simpleParameterizedBaseApi() throws Exception {
587-
List<MethodMetadata> md = contract.parseAndValidatateMetadata(SimpleParameterizedApi.class);
587+
List<MethodMetadata> md = contract.parseAndValidateMetadata(SimpleParameterizedApi.class);
588588

589589
assertThat(md).hasSize(1);
590590

@@ -600,7 +600,7 @@ public void simpleParameterizedBaseApi() throws Exception {
600600
public void parameterizedApiUnsupported() throws Exception {
601601
thrown.expect(IllegalStateException.class);
602602
thrown.expectMessage("Parameterized types unsupported: SimpleParameterizedBaseApi");
603-
contract.parseAndValidatateMetadata(SimpleParameterizedBaseApi.class);
603+
contract.parseAndValidateMetadata(SimpleParameterizedBaseApi.class);
604604
}
605605

606606
interface OverrideParameterizedApi extends SimpleParameterizedBaseApi<String> {
@@ -614,7 +614,7 @@ interface OverrideParameterizedApi extends SimpleParameterizedBaseApi<String> {
614614
public void overrideBaseApiUnsupported() throws Exception {
615615
thrown.expect(IllegalStateException.class);
616616
thrown.expectMessage("Overrides unsupported: OverrideParameterizedApi#get(String)");
617-
contract.parseAndValidatateMetadata(OverrideParameterizedApi.class);
617+
contract.parseAndValidateMetadata(OverrideParameterizedApi.class);
618618
}
619619

620620
interface Child<T> extends SimpleParameterizedBaseApi<List<T>> {
@@ -629,7 +629,7 @@ interface GrandChild extends Child<String> {
629629
public void onlySingleLevelInheritanceSupported() throws Exception {
630630
thrown.expect(IllegalStateException.class);
631631
thrown.expectMessage("Only single-level inheritance supported: GrandChild");
632-
contract.parseAndValidatateMetadata(GrandChild.class);
632+
contract.parseAndValidateMetadata(GrandChild.class);
633633
}
634634

635635
@Headers("Foo: Bar")
@@ -671,7 +671,7 @@ interface ParameterizedApi extends ParameterizedBaseApi<String, Long> {
671671

672672
@Test
673673
public void parameterizedBaseApi() throws Exception {
674-
List<MethodMetadata> md = contract.parseAndValidatateMetadata(ParameterizedApi.class);
674+
List<MethodMetadata> md = contract.parseAndValidateMetadata(ParameterizedApi.class);
675675

676676
Map<String, MethodMetadata> byConfigKey = new LinkedHashMap<String, MethodMetadata>();
677677
for (MethodMetadata m : md) {
@@ -706,7 +706,7 @@ interface ParameterizedHeaderExpandApi {
706706
@Test
707707
public void parameterizedHeaderExpandApi() throws Exception {
708708
List<MethodMetadata> md =
709-
contract.parseAndValidatateMetadata(ParameterizedHeaderExpandApi.class);
709+
contract.parseAndValidateMetadata(ParameterizedHeaderExpandApi.class);
710710

711711
assertThat(md).hasSize(1);
712712

@@ -725,7 +725,7 @@ public void parameterizedHeaderExpandApi() throws Exception {
725725
@Test
726726
public void parameterizedHeaderNotStartingWithCurlyBraceExpandApi() throws Exception {
727727
List<MethodMetadata> md =
728-
contract.parseAndValidatateMetadata(
728+
contract.parseAndValidateMetadata(
729729
ParameterizedHeaderNotStartingWithCurlyBraceExpandApi.class);
730730

731731
assertThat(md).hasSize(1);
@@ -765,7 +765,7 @@ interface ParameterizedHeaderExpandInheritedApi extends ParameterizedHeaderBase
765765
@Test
766766
public void parameterizedHeaderExpandApiBaseClass() throws Exception {
767767
List<MethodMetadata> mds =
768-
contract.parseAndValidatateMetadata(ParameterizedHeaderExpandInheritedApi.class);
768+
contract.parseAndValidateMetadata(ParameterizedHeaderExpandInheritedApi.class);
769769

770770
Map<String, MethodMetadata> byConfigKey = new LinkedHashMap<String, MethodMetadata>();
771771
for (MethodMetadata m : mds) {
@@ -816,7 +816,7 @@ public void missingMethod() throws Exception {
816816
thrown.expectMessage(
817817
"RequestLine annotation didn't start with an HTTP verb on method MissingMethod#updateSharing");
818818

819-
contract.parseAndValidatateMetadata(MissingMethod.class);
819+
contract.parseAndValidateMetadata(MissingMethod.class);
820820
}
821821

822822
interface StaticMethodOnInterface {
@@ -830,7 +830,7 @@ static String staticMethod() {
830830

831831
@Test
832832
public void staticMethodsOnInterfaceIgnored() throws Exception {
833-
List<MethodMetadata> mds = contract.parseAndValidatateMetadata(StaticMethodOnInterface.class);
833+
List<MethodMetadata> mds = contract.parseAndValidateMetadata(StaticMethodOnInterface.class);
834834
assertThat(mds).hasSize(1);
835835
MethodMetadata md = mds.get(0);
836836
assertThat(md.configKey()).isEqualTo("StaticMethodOnInterface#get(String)");
@@ -847,7 +847,7 @@ default String defaultGet(String key) {
847847

848848
@Test
849849
public void defaultMethodsOnInterfaceIgnored() throws Exception {
850-
List<MethodMetadata> mds = contract.parseAndValidatateMetadata(DefaultMethodOnInterface.class);
850+
List<MethodMetadata> mds = contract.parseAndValidateMetadata(DefaultMethodOnInterface.class);
851851
assertThat(mds).hasSize(1);
852852
MethodMetadata md = mds.get(0);
853853
assertThat(md.configKey()).isEqualTo("DefaultMethodOnInterface#get(String)");
@@ -860,7 +860,7 @@ interface SubstringQuery {
860860

861861
@Test
862862
public void paramIsASubstringOfAQuery() throws Exception {
863-
List<MethodMetadata> mds = contract.parseAndValidatateMetadata(SubstringQuery.class);
863+
List<MethodMetadata> mds = contract.parseAndValidateMetadata(SubstringQuery.class);
864864

865865
assertThat(mds.get(0).template().queries()).containsExactly(
866866
entry("q", asList("body:{body}")));

‎hystrix/src/main/java/feign/hystrix/HystrixDelegatingContract.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ public HystrixDelegatingContract(Contract delegate) {
4343
}
4444

4545
@Override
46-
public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
47-
List<MethodMetadata> metadatas = this.delegate.parseAndValidatateMetadata(targetType);
46+
public List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType) {
47+
List<MethodMetadata> metadatas = this.delegate.parseAndValidateMetadata(targetType);
4848

4949
for (MethodMetadata metadata : metadatas) {
5050
Type type = metadata.returnType();

‎reactive/src/main/java/feign/reactive/ReactiveDelegatingContract.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public class ReactiveDelegatingContract implements Contract {
3232
}
3333

3434
@Override
35-
public List<MethodMetadata> parseAndValidatateMetadata(Class<?> targetType) {
36-
List<MethodMetadata> methodsMetadata = this.delegate.parseAndValidatateMetadata(targetType);
35+
public List<MethodMetadata> parseAndValidateMetadata(Class<?> targetType) {
36+
List<MethodMetadata> methodsMetadata = this.delegate.parseAndValidateMetadata(targetType);
3737

3838
for (final MethodMetadata metadata : methodsMetadata) {
3939
final Type type = metadata.returnType();

‎reactive/src/test/java/feign/reactive/ReactiveDelegatingContractTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,26 @@ public class ReactiveDelegatingContractTest {
3434
public void onlyReactiveReturnTypesSupported() {
3535
this.thrown.expect(IllegalArgumentException.class);
3636
Contract contract = new ReactiveDelegatingContract(new Contract.Default());
37-
contract.parseAndValidatateMetadata(TestSynchronousService.class);
37+
contract.parseAndValidateMetadata(TestSynchronousService.class);
3838
}
3939

4040
@Test
4141
public void reactorTypes() {
4242
Contract contract = new ReactiveDelegatingContract(new Contract.Default());
43-
contract.parseAndValidatateMetadata(TestReactorService.class);
43+
contract.parseAndValidateMetadata(TestReactorService.class);
4444
}
4545

4646
@Test
4747
public void reactivexTypes() {
4848
Contract contract = new ReactiveDelegatingContract(new Contract.Default());
49-
contract.parseAndValidatateMetadata(TestReactiveXService.class);
49+
contract.parseAndValidateMetadata(TestReactiveXService.class);
5050
}
5151

5252
@Test
5353
public void streamsAreNotSupported() {
5454
this.thrown.expect(IllegalArgumentException.class);
5555
Contract contract = new ReactiveDelegatingContract(new Contract.Default());
56-
contract.parseAndValidatateMetadata(StreamsService.class);
56+
contract.parseAndValidateMetadata(StreamsService.class);
5757
}
5858

5959
public interface TestSynchronousService {

0 commit comments

Comments
 (0)