Module de.cuioss.http
Package de.cuioss.http.client.converter

Class StringContentConverter<T>

java.lang.Object
de.cuioss.http.client.converter.StringContentConverter<T>
Type Parameters:
T - the target type for content conversion
All Implemented Interfaces:
HttpContentConverter<T>
public abstract class StringContentConverter<T> extends Object implements HttpContentConverter<T>
Base class for content converters that process String-based HTTP responses.

This converter is suitable for text-based content types such as JSON, XML, HTML, and plain text. It uses HttpResponse.BodyHandlers.ofString() with configurable charset support.

Subclasses need only implement the conversion logic and empty value provision. The String raw type handling is managed internally.

Since:
1.0
Author:
Oliver Wolff

  • Constructor Details

    • StringContentConverter

      protected StringContentConverter()
      Creates a String content converter with UTF-8 charset.

    • StringContentConverter

      protected StringContentConverter(@NonNull @NonNull Charset charset)
      Creates a String content converter with specified charset.
      Parameters:
      charset - the charset to use for String decoding

  • Method Details

    • getBodyHandler

      public HttpResponse.BodyHandler<?> getBodyHandler()
      Description copied from interface: HttpContentConverter
      Provides the appropriate BodyHandler for this converter.

      This method enables proper leveraging of Java HTTP Client's type-safe body handling, avoiding unnecessary intermediate conversions and preserving data integrity. The raw type is handled internally by the implementation.

      Examples:

      • For JSON/XML: HttpResponse.BodyHandlers.ofString(charset)
      • For binary data: HttpResponse.BodyHandlers.ofByteArray()
      • For large content: HttpResponse.BodyHandlers.ofInputStream()
      Specified by:
      getBodyHandler in interface HttpContentConverter<T>
      Returns:
      the BodyHandler appropriate for this converter

    • convert

      public Optional<T> convert(Object rawContent)
      Description copied from interface: HttpContentConverter
      Converts raw HTTP response body to the target type.

      Returns Optional.empty() when:

      • Conversion fails due to malformed content
      • Content is empty or null
      • Content cannot be meaningfully converted
      Specified by:
      convert in interface HttpContentConverter<T>
      Parameters:
      rawContent - the raw HTTP response body (may be null or empty)
      Returns:
      Optional containing converted content, or empty if conversion fails

    • convertString

      protected abstract Optional<T> convertString(String rawContent)
      Converts String content to the target type. This method is called by the public convert method after casting.
      Parameters:
      rawContent - the raw String content from HTTP response
      Returns:
      Optional containing converted content, or empty if conversion fails

    • identity

      public static StringContentConverter<String> identity()
      Identity converter for String content (no conversion needed).

      This is the most basic String converter that returns the input unchanged, suitable for cases where the raw String response is the desired result.

      Returns:
      converter that returns the input String unchanged