Record Class ResponseBodyMapping

java.lang.Object
java.lang.Record
io.micronaut.openapi.generator.ResponseBodyMapping
Record Components:
headerName - The response header name that triggers the change of response type.
mappedBodyType - The type in which will be used as the response type. The type must take a single type parameter, which will be the original body.
isListWrapper - Whether the mapped body type needs to be supplied list items as property.
isValidated - Whether the mapped response body type required validation.
public record ResponseBodyMapping(String headerName, String mappedBodyType, boolean isListWrapper, boolean isValidated) extends Record
A record that can be used to specify parameter mapping. Parameter mapping would map a given parameter to a specific type and name.

  • Constructor Details

    • ResponseBodyMapping

      public ResponseBodyMapping(String headerName, String mappedBodyType, boolean isListWrapper, boolean isValidated)
      Creates an instance of a ResponseBodyMapping record class.
      Parameters:
      headerName - the value for the headerName record component
      mappedBodyType - the value for the mappedBodyType record component
      isListWrapper - the value for the isListWrapper record component
      isValidated - the value for the isValidated record component

  • Method Details

    • doesMatch

      public boolean doesMatch(String header, boolean isBodyList)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • headerName

      public String headerName()
      Returns the value of the headerName record component.
      Returns:
      the value of the headerName record component

    • mappedBodyType

      public String mappedBodyType()
      Returns the value of the mappedBodyType record component.
      Returns:
      the value of the mappedBodyType record component

    • isListWrapper

      public boolean isListWrapper()
      Returns the value of the isListWrapper record component.
      Returns:
      the value of the isListWrapper record component

    • isValidated

      public boolean isValidated()
      Returns the value of the isValidated record component.
      Returns:
      the value of the isValidated record component