Record Class ModelConfigParameter

java.lang.Object
java.lang.Record
ai.timefold.solver.service.definition.internal.descriptor.ModelConfigParameter
Record Components:
id - the parameter id
name - the human-readable name
description - the parameter human-readable description
kind - the parameter kind
type - the OpenAPI schema type
arrayItemType - the OpenAPI schema type for array items
format - the data format which further specifies the schema type
schemaTypeRef - the OpenAPI schema type reference (used when the schema type is not a primitive type)
nullable - whether the parameter accepts null as a value, as defined by the OpenAPI schema
constraintNameRef - the constraint name reference (used when the parameter is a constraint weight or any other parameter related to a constraint)
public record ModelConfigParameter(String id, String name, String description, ParameterKind kind, org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type, org.eclipse.microprofile.openapi.models.media.Schema.SchemaType arrayItemType, DataFormat format, String schemaTypeRef, boolean nullable, String constraintNameRef) extends Record
Represents a constraint parameter, which is the constraint weight or any other parameter impacting the constraint behavior.

Parameters are defined by the model in the ModelConfigOverrides class.

  • Constructor Details

    • ModelConfigParameter

      public ModelConfigParameter(String id, String name, String description, ParameterKind kind, org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type, org.eclipse.microprofile.openapi.models.media.Schema.SchemaType arrayItemType, DataFormat format, String schemaTypeRef, boolean nullable, String constraintNameRef)
      Creates an instance of a ModelConfigParameter record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      description - the value for the description record component
      kind - the value for the kind record component
      type - the value for the type record component
      arrayItemType - the value for the arrayItemType record component
      format - the value for the format record component
      schemaTypeRef - the value for the schemaTypeRef record component
      nullable - the value for the nullable record component
      constraintNameRef - the value for the constraintNameRef record component

  • Method Details

    • 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.

    • id

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

    • name

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

    • description

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

    • kind

      public ParameterKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • type

      public org.eclipse.microprofile.openapi.models.media.Schema.SchemaType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • arrayItemType

      public org.eclipse.microprofile.openapi.models.media.Schema.SchemaType arrayItemType()
      Returns the value of the arrayItemType record component.
      Returns:
      the value of the arrayItemType record component

    • format

      public DataFormat format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • schemaTypeRef

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

    • nullable

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

    • constraintNameRef

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