Record Class Info

java.lang.Object
java.lang.Record
org.infinispan.rest.framework.openapi.Info
Record Components:
title - : A required property with the title of the API.
description - : A optional property with a description about the API.
license - : A optional property with the license information about the software.
version - : A required property with the software version.
All Implemented Interfaces:
JsonSerialization
public record Info(String title, String description, License license, String version) extends Record implements JsonSerialization
The Info object holds metadata about the API.
See Also:

  • Constructor Details

    • Info

      public Info(String title, String description, License license, String version)
      Creates an instance of a Info record class.
      Parameters:
      title - the value for the title record component
      description - the value for the description record component
      license - the value for the license record component
      version - the value for the version record component

  • Method Details

    • toJson

      public Json toJson()
      Specified by:
      toJson in interface JsonSerialization

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • title

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

    • description

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

    • license

      public License license()
      Returns the value of the license record component.
      Returns:
      the value of the license record component

    • version

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