javadoc fixes (#51)

Co-authored-by: Alex Danilenko <[email protected]>

Author: lazer-dev

core/src/main/java/spotty/common/http/HttpHeaders.java

@@ -391,6 +391,7 @@ public boolean hasNot(String name) {
      * Returns <tt>true</tt> if this HttpHeaders contains a header for the specified name and header value is equal with given.
      *
      * @param name header name
+     * @param value header value
      * @return <tt>true</tt> if this HttpHeaders contains a header for the specified name and header value is equal with given.
      */
     public boolean hasAndEqual(String name, String value) {

core/src/main/java/spotty/common/http/HttpStatus.java

@@ -223,7 +223,6 @@ public enum HttpStatus {
     PRECONDITION_FAILED(412, Series.CLIENT_ERROR, "Precondition Failed"),
     /**
      * {@code 413 Payload Too Large}.
-     * @since 4.1
      * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.11">
      *     HTTP/1.1: Semantics and Content, section 6.5.11</a>
      */
@@ -238,7 +237,6 @@ public enum HttpStatus {
     REQUEST_ENTITY_TOO_LARGE(413, Series.CLIENT_ERROR, "Request Entity Too Large"),
     /**
      * {@code 414 URI Too Long}.
-     * @since 4.1
      * @see <a href="https://tools.ietf.org/html/rfc7231#section-6.5.12">
      *     HTTP/1.1: Semantics and Content, section 6.5.12</a>
      */
@@ -310,7 +308,6 @@ public enum HttpStatus {
     FAILED_DEPENDENCY(424, Series.CLIENT_ERROR, "Failed Dependency"),
     /**
      * {@code 425 Too Early}.
-     * @since 5.2
      * @see <a href="https://tools.ietf.org/html/rfc8470">RFC 8470</a>
      */
     TOO_EARLY(425, Series.CLIENT_ERROR, "Too Early"),
@@ -338,7 +335,6 @@ public enum HttpStatus {
      * {@code 451 Unavailable For Legal Reasons}.
      * @see <a href="https://tools.ietf.org/html/draft-ietf-httpbis-legally-restricted-status-04">
      * An HTTP Status Code to Report Legal Obstacles</a>
-     * @since 4.3
      */
     UNAVAILABLE_FOR_LEGAL_REASONS(451, Series.CLIENT_ERROR, "Unavailable For Legal Reasons"),
 
@@ -421,8 +417,8 @@ public enum HttpStatus {
      * Whether this status code is in the HTTP series
      * {@link spotty.common.http.HttpStatus.Series#INFORMATIONAL}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 4.0
      * @see #series
+     * @return true if series informational
      */
     public boolean is1xxInformational() {
         return (series == Series.INFORMATIONAL);
@@ -432,8 +428,8 @@ public boolean is1xxInformational() {
      * Whether this status code is in the HTTP series
      * {@link spotty.common.http.HttpStatus.Series#SUCCESSFUL}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 4.0
      * @see #series
+     * @return true if series successful
      */
     public boolean is2xxSuccessful() {
         return (series == Series.SUCCESSFUL);
@@ -443,8 +439,8 @@ public boolean is2xxSuccessful() {
      * Whether this status code is in the HTTP series
      * {@link spotty.common.http.HttpStatus.Series#REDIRECTION}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 4.0
      * @see #series
+     * @return true if series redirection
      */
     public boolean is3xxRedirection() {
         return (series == Series.REDIRECTION);
@@ -454,8 +450,8 @@ public boolean is3xxRedirection() {
      * Whether this status code is in the HTTP series
      * {@link spotty.common.http.HttpStatus.Series#CLIENT_ERROR}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 4.0
      * @see #series
+     * @return true if series related to client errors
      */
     public boolean is4xxClientError() {
         return (series == Series.CLIENT_ERROR);
@@ -465,8 +461,8 @@ public boolean is4xxClientError() {
      * Whether this status code is in the HTTP series
      * {@link spotty.common.http.HttpStatus.Series#SERVER_ERROR}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 4.0
      * @see #series
+     * @return true if series related to server errors
      */
     public boolean is5xxServerError() {
         return (series == Series.SERVER_ERROR);
@@ -477,9 +473,9 @@ public boolean is5xxServerError() {
      * {@link spotty.common.http.HttpStatus.Series#CLIENT_ERROR} or
      * {@link spotty.common.http.HttpStatus.Series#SERVER_ERROR}.
      * <p>This is a shortcut for checking the value of {@link #series}.
-     * @since 5.0
      * @see #is4xxClientError()
      * @see #is5xxServerError()
+     * @return true if status related to 4xx or 5xx errors
      */
     public boolean isError() {
         return (is4xxClientError() || is5xxServerError());
@@ -511,7 +507,6 @@ public static HttpStatus valueOf(int statusCode) {
      * Resolve the given status code to an {@code HttpStatus}, if possible.
      * @param statusCode the HTTP status code (potentially non-standard)
      * @return the corresponding {@code HttpStatus}, or {@code null} if not found
-     * @since 5.0
      */
     public static HttpStatus resolve(int statusCode) {
         // Use cached VALUES instead of values() to prevent array allocation.
@@ -545,6 +540,7 @@ public enum Series {
 
         /**
          * Return the integer value of this status series. Ranges from 1 to 5.
+         * @return series value
          */
         public int value() {
             return this.value;
@@ -580,7 +576,6 @@ public static Series valueOf(int statusCode) {
          * Resolve the given status code to an {@code HttpStatus.Series}, if possible.
          * @param statusCode the HTTP status code (potentially non-standard)
          * @return the corresponding {@code Series}, or {@code null} if not found
-         * @since 5.1.3
          */
         public static Series resolve(int statusCode) {
             int seriesCode = statusCode / 100;

core/src/main/java/spotty/common/request/SpottyRequest.java

@@ -106,6 +106,7 @@ public interface SpottyRequest {
     Set<String> queryParams();
 
     /**
+     * @param name query param name
      * @return query param values
      */
     Set<String> queryParams(String name);
@@ -118,6 +119,7 @@ public interface SpottyRequest {
 
     /**
      * set an attachment object (can be fetched in filters/routes later in the chain)
+     * @param attachment attachment object
      */
     void attach(Object attachment);
 

core/src/main/java/spotty/common/response/SpottyResponse.java

@@ -219,6 +219,7 @@ public SpottyResponse cookie(Cookie cookie) {
      *
      * @param name  name of the cookie
      * @param value value of the cookie
+     * @return Response object
      */
     public SpottyResponse cookie(String name, String value) {
         return cookie(Cookie.builder()
@@ -234,6 +235,7 @@ public SpottyResponse cookie(String name, String value) {
      * @param name   name of the cookie
      * @param value  value of the cookie
      * @param maxAge max age of the cookie in seconds (zero - deletes the cookie)
+     * @return Response object
      */
     public SpottyResponse cookie(String name, String value, int maxAge) {
         return cookie(Cookie.builder()
@@ -251,6 +253,7 @@ public SpottyResponse cookie(String name, String value, int maxAge) {
      * @param value   value of the cookie
      * @param maxAge  max age of the cookie in seconds (zero - deletes the cookie)
      * @param secured if true : cookie will be secured
+     * @return Response object
      */
     public SpottyResponse cookie(String name, String value, int maxAge, boolean secured) {
         return cookie(Cookie.builder()
@@ -270,6 +273,7 @@ public SpottyResponse cookie(String name, String value, int maxAge, boolean secu
      * @param maxAge   max age of the cookie in seconds (zero - deletes the cookie)
      * @param secured  if true : cookie will be secured
      * @param httpOnly if true: cookie will be marked as http only
+     * @return Response object
      */
     public SpottyResponse cookie(String name, String value, int maxAge, boolean secured, boolean httpOnly) {
         return cookie(Cookie.builder()
@@ -290,6 +294,7 @@ public SpottyResponse cookie(String name, String value, int maxAge, boolean secu
      * @param value   value of the cookie
      * @param maxAge  max age of the cookie in seconds (zero - deletes the cookie)
      * @param secured if true : cookie will be secured
+     * @return Response object
      */
     public SpottyResponse cookie(String path, String name, String value, int maxAge, boolean secured) {
         return cookie(Cookie.builder()
@@ -311,6 +316,7 @@ public SpottyResponse cookie(String path, String name, String value, int maxAge,
      * @param maxAge   max age of the cookie in seconds (zero - deletes the cookie)
      * @param secured  if true : cookie will be secured
      * @param httpOnly if true: cookie will be marked as http only
+     * @return Response object
      */
     public SpottyResponse cookie(String path, String name, String value, int maxAge, boolean secured, boolean httpOnly) {
         return cookie(Cookie.builder()
@@ -334,6 +340,7 @@ public SpottyResponse cookie(String path, String name, String value, int maxAge,
      * @param maxAge   max age of the cookie in seconds (zero - deletes the cookie)
      * @param secured  if true : cookie will be secured
      * @param httpOnly if true: cookie will be marked as http only
+     * @return Response object
      */
     public SpottyResponse cookie(String domain, String path, String name, String value, int maxAge, boolean secured, boolean httpOnly) {
         return cookie(Cookie.builder()
@@ -351,6 +358,7 @@ public SpottyResponse cookie(String domain, String path, String name, String val
      * Removes the cookie.
      *
      * @param name name of the cookie
+     * @return Response object
      */
     public SpottyResponse removeCookie(String name) {
         return removeCookie(null, name);
@@ -361,6 +369,7 @@ public SpottyResponse removeCookie(String name) {
      *
      * @param path path of the cookie
      * @param name name of the cookie
+     * @return Response object
      */
     public SpottyResponse removeCookie(String path, String name) {
         return cookie(

core/src/main/java/spotty/common/session/Session.java

@@ -112,6 +112,7 @@ public Session putIfAbsent(Object key, Object value) {
      *
      * @param key    key with which the specified value is to be associated
      * @param mapper the function to compute a value
+     * @param <T> return type
      * @return the current (existing or computed) value associated with
      * the specified key, or null if the computed value is null
      */
@@ -131,6 +132,7 @@ public <T> T computeIfAbsent(Object key, Function<Object, T> mapper) {
      *
      * @param key    key with which the specified value is to be associated
      * @param mapper the function to compute a value
+     * @param <T> return type
      * @return the current (existing or computed) value associated with
      * the specified key, or null if the computed value is null
      */
@@ -152,6 +154,7 @@ public <T> T computeIfPresent(Object key, BiFunction<Object, T, T> mapper) {
      *
      * @param key    key with which the specified value is to be associated
      * @param mapper the function to compute a value
+     * @param <T> return type
      * @return the new value associated with the specified key, or null if none
      */
     @SuppressWarnings("all")
@@ -174,6 +177,7 @@ public Session putAll(Map<Object, Object> data) {
      * Returns the value by specified key, or {@code null} if no value for the key.
      *
      * @param key the key whose associated value is to be returned
+     * @param <T> return type
      * @return the value to which the specified key is mapped, or
      * {@code null} if this session contains no mapping for the key
      */
@@ -188,6 +192,7 @@ public <T> T get(Object key) {
      *
      * @param key          the key whose associated value is to be returned
      * @param defaultValue the default mapping of the key
+     * @param <T> return type
      * @return the value to which the specified key is mapped, or
      * {@code defaultValue} if this map contains no mapping for the key
      */
@@ -197,7 +202,7 @@ public <T> T getOrDefault(Object key, T defaultValue) {
     }
 
     /**
-     * Returns the number of data in this session
+     * @return Returns the number of data in this session
      */
     public int size() {
         return data.size();