feat: added javadocs

Onlineberatung · Dec 2, 2020 · c8b11f1 · c8b11f1
1 parent 6f4e05b
commit c8b11f1
Showing 1 changed file with 10 additions and 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
@@ -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);