From c8b11f1f465cd41db833641bcbe0f8a81afc2258 Mon Sep 17 00:00:00 2001 From: mebo4b Date: Wed, 2 Dec 2020 08:48:35 +0100 Subject: [PATCH] feat: added javadocs --- .../api/exception/cutomheader/CustomHttpHeader.java | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/main/java/de/caritas/cob/uploadservice/api/exception/cutomheader/CustomHttpHeader.java b/src/main/java/de/caritas/cob/uploadservice/api/exception/cutomheader/CustomHttpHeader.java index dbdf4b5..7509da0 100644 --- a/src/main/java/de/caritas/cob/uploadservice/api/exception/cutomheader/CustomHttpHeader.java +++ b/src/main/java/de/caritas/cob/uploadservice/api/exception/cutomheader/CustomHttpHeader.java @@ -3,14 +3,22 @@ import lombok.AllArgsConstructor; import org.springframework.http.HttpHeaders; +/** + * Constants to build custom http headers. + */ @AllArgsConstructor public enum CustomHttpHeader { QUOTA_REACHED("X-Reason", "QUOTA_REACHED"); - private String headerName; - private String headerValue; + private final String headerName; + private final String headerValue; + /** + * Builds the {@link HttpHeaders} for the custom values. + * + * @return the {@link HttpHeaders} instance + */ public HttpHeaders buildHeader() { HttpHeaders headers = new HttpHeaders(); headers.add(headerName, headerValue);