This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 295cdd8 Remove redundancy in HttpPart annotations.
295cdd8 is described below
commit 295cdd8b295bba7ee229205543bbfcf5e3c8c392
Author: JamesBognar <[email protected]>
AuthorDate: Sat Nov 27 12:53:07 2021 -0500
Remove redundancy in HttpPart annotations.
---
.../apache/juneau/http/annotation/ResponseHeader.java | 12 ------------
.../http/annotation/ResponseHeaderAnnotation.java | 19 -------------------
.../src/main/javadoc/resources/fragments/toc.html | 4 ++--
.../juneau/rest/BasicSwaggerProviderSession.java | 14 ++------------
.../juneau/http/annotation/AnnotationUtils_Test.java | 5 -----
.../annotation/ResponseHeaderAnnotation_Test.java | 5 -----
.../juneau/rest/annotation/ResponseHeader_Test.java | 8 ++++----
7 files changed, 8 insertions(+), 59 deletions(-)
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
index 2ae34e9..00a2af0 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeader.java
@@ -132,18 +132,6 @@ import org.apache.juneau.oapi.*;
public @interface ResponseHeader {
/**
- * The HTTP status (or statuses) of the response.
- *
- * <ul class='notes'>
- * <li>
- * The is a comma-delimited list of HTTP status codes that
this header applies to.
- * <li>
- * The default value is <js>"200"</js>.
- * </ul>
- */
- int[] code() default {};
-
- /**
* The HTTP header name.
*
* <ul class='notes'>
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation.java
index bef338d..c214228 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation.java
@@ -109,7 +109,6 @@ public class ResponseHeaderAnnotation {
public static class Builder extends TargetedAnnotationTMBuilder {
Class<? extends HttpPartSerializer> serializer =
HttpPartSerializer.Null.class;
- int[] code={};
Schema schema = SchemaAnnotation.DEFAULT;
String name="", value="";
@@ -130,17 +129,6 @@ public class ResponseHeaderAnnotation {
}
/**
- * Sets the {@link ResponseHeader#code} property on this
annotation.
- *
- * @param value The new value for this property.
- * @return This object.
- */
- public Builder code(int...value) {
- this.code = value;
- return this;
- }
-
- /**
* Sets the {@link ResponseHeader#name} property on this
annotation.
*
* @param value The new value for this property.
@@ -220,13 +208,11 @@ public class ResponseHeaderAnnotation {
private static class Impl extends TargetedAnnotationTImpl implements
ResponseHeader {
private final Class<? extends HttpPartSerializer> serializer;
- private final int[] code;
private final String name, value;
private final Schema schema;
Impl(Builder b) {
super(b);
- this.code = Arrays.copyOf(b.code, b.code.length);
this.name = b.name;
this.schema = b.schema;
this.serializer = b.serializer;
@@ -235,11 +221,6 @@ public class ResponseHeaderAnnotation {
}
@Override /* ResponseHeader */
- public int[] code() {
- return code;
- }
-
- @Override /* ResponseHeader */
public String name() {
return name;
}
diff --git a/juneau-doc/src/main/javadoc/resources/fragments/toc.html
b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
index e0abcf5..342c7c6 100644
--- a/juneau-doc/src/main/javadoc/resources/fragments/toc.html
+++ b/juneau-doc/src/main/javadoc/resources/fragments/toc.html
@@ -208,7 +208,7 @@
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.Header_Path_Query_FormData'>@Header
/ @Path / @Query / @FormData</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.Body'>@Body and Request
Bodies</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.RequestBeans'>@Request
beans</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
- <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ReponseHeader_ResponseCode'>@Response
/ @ResponseHeader / @ResponseCode</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
+ <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ReponseHeader_ResponseStatus'>@Response
/ @ResponseHeader / @ResponseCode</a><span class='update'>updated:
8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.ResponseBeans'>@Response
beans</a><span class='update'>updated: 8.1.0,<b>9.0.0</b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-server.HttpParts.RequestHeader_RequestQueryParams_RequestFormParams_RequestPathParams'>RequestHeaders
/ RequestQueryParams / RequestFormParams / RequestPathParams</a><span
class='update'>created: <b>9.0.0</b></span></p>
</ol>
@@ -284,7 +284,7 @@
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestQueryParameters'>Request
Query Parameters</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestFormData'>Request Form
Data</a><span class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcRequestBody'>Request Body</a><span
class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
- <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseCode'>Response
Status</a><span class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
+ <li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseStatus'>Response
Status</a><span class='update'>created: 8.1.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseHeaders'>Response
Headers</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcResponseBody'>Response
Body</a><span class='update'>created: 8.2.0, <b><red>todo</red></b></span></p>
<li><p><a class='doclink'
href='{OVERVIEW_URL}#juneau-rest-client.RestcCustomCallHandlers'>Custom Call
Handlers</a><span class='update'>created: 8.2.0,
<b><red>todo</red></b></span></p>
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicSwaggerProviderSession.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicSwaggerProviderSession.java
index 5a0990f..706cb85 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicSwaggerProviderSession.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/BasicSwaggerProviderSession.java
@@ -449,7 +449,8 @@ public class BasicSwaggerProviderSession {
if (mpi.hasAnnotation(ResponseHeader.class) ||
pt.hasAnnotation(ResponseHeader.class)) {
List<ResponseHeader> la =
AList.of(mpi.getAnnotations(ResponseHeader.class)).a(pt.getAnnotations(ResponseHeader.class));
- Set<Integer> codes = getCodes2(la, 200);
+ List<ResponseCode> la2 =
AList.of(mpi.getAnnotations(ResponseCode.class)).a(pt.getAnnotations(ResponseCode.class));
+ Set<Integer> codes = getCodes(la2, 200);
String name =
ResponseHeaderAnnotation.findName(la).orElse(null);
Type type =
Value.unwrap(mpi.getParameterType().innerType());
for (ResponseHeader a : la) {
@@ -1102,17 +1103,6 @@ public class BasicSwaggerProviderSession {
return codes;
}
- private static Set<Integer> getCodes2(List<ResponseHeader> la, Integer
def) {
- Set<Integer> codes = new TreeSet<>();
- for (ResponseHeader a : la) {
- for (int i : a.code())
- codes.add(i);
- }
- if (codes.isEmpty() && def != null)
- codes.add(def);
- return codes;
- }
-
private static OMap nullIfEmpty(OMap m) {
return (m == null || m.isEmpty() ? null : m);
}
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
index c76e2e1..d022bbd 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/AnnotationUtils_Test.java
@@ -218,7 +218,6 @@ public class AnnotationUtils_Test {
assertTrue(ResponseHeaderAnnotation.empty(A1.class.getAnnotation(ResponseHeader.class)));
assertTrue(ResponseHeaderAnnotation.empty(A2.class.getAnnotation(ResponseHeader.class)));
-
assertFalse(ResponseHeaderAnnotation.empty(responseHeader().code(a(0)).build()));
assertFalse(ResponseHeaderAnnotation.empty(responseHeader().name("foo").build()));
assertFalse(ResponseHeaderAnnotation.empty(responseHeader().serializer(OpenApiSerializer.class).build()));
assertFalse(ResponseHeaderAnnotation.empty(responseHeader().value("foo").build()));
@@ -486,8 +485,4 @@ public class AnnotationUtils_Test {
private static String[] a(String...s) {
return s;
}
-
- private static int[] a(int...i) {
- return i;
- }
}
\ No newline at end of file
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation_Test.java
index f12a185..9d7d8c7 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/http/annotation/ResponseHeaderAnnotation_Test.java
@@ -32,7 +32,6 @@ public class ResponseHeaderAnnotation_Test {
//------------------------------------------------------------------------------------------------------------------
ResponseHeader a1 = ResponseHeaderAnnotation.create()
- .code(1)
.name("name")
.on("on")
.onClass(X1.class)
@@ -41,7 +40,6 @@ public class ResponseHeaderAnnotation_Test {
.build();
ResponseHeader a2 = ResponseHeaderAnnotation.create()
- .code(1)
.name("name")
.on("on")
.onClass(X1.class)
@@ -53,7 +51,6 @@ public class ResponseHeaderAnnotation_Test {
public void a01_basic() {
assertObject(a1).asJson().matches(""
+ "{"
- + "code:[1],"
+ "name:'name',"
+ "on:['on'],"
+ "onClass:['"+CNAME+"$X1'],"
@@ -110,7 +107,6 @@ public class ResponseHeaderAnnotation_Test {
//------------------------------------------------------------------------------------------------------------------
@ResponseHeader(
- code=1,
name="name",
on="on",
onClass=X1.class,
@@ -121,7 +117,6 @@ public class ResponseHeaderAnnotation_Test {
ResponseHeader d1 =
D1.class.getAnnotationsByType(ResponseHeader.class)[0];
@ResponseHeader(
- code=1,
name="name",
on="on",
onClass=X1.class,
diff --git
a/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseHeader_Test.java
b/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseHeader_Test.java
index a08eb19..4786ae0 100644
---
a/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseHeader_Test.java
+++
b/juneau-utest/src/test/java/org/apache/juneau/rest/annotation/ResponseHeader_Test.java
@@ -108,12 +108,12 @@ public class ResponseHeader_Test {
@RestGet
public void c(Value<B3> h) {}
- @ResponseHeader(name="H", code=100)
+ @ResponseHeader(name="H") @ResponseCode(100)
public static class B4 {}
@RestGet
public void d(Value<B4> h) {}
- @ResponseHeader(name="H", code={100,101})
+ @ResponseHeader(name="H") @ResponseCode({100,101})
public static class B5 {}
@RestGet
public void e(Value<B5> h) {}
@@ -203,11 +203,11 @@ public class ResponseHeader_Test {
public static class C4 {}
@RestGet
- public void d(@ResponseHeader(name="H", code=100) Value<C4> h)
{}
+ public void d(@ResponseHeader(name="H") @ResponseCode(100)
Value<C4> h) {}
public static class C5 {}
@RestGet
- public void e(@ResponseHeader(name="H", code={100,101})
Value<C5> h) {}
+ public void e(@ResponseHeader(name="H")
@ResponseCode({100,101}) Value<C5> h) {}
public static class C6 {}
@RestGet
