Record Class DocumentationDescriptor

java.lang.Object
java.lang.Record
ai.timefold.solver.service.definition.internal.descriptor.DocumentationDescriptor
Record Components:
support - the level of documentation support available
source - an optional URL pointing to the documentation source
public record DocumentationDescriptor(DocumentationSupport support, Optional<URL> source) extends Record
Describes the documentation support for a model.

  • Constructor Details

    • DocumentationDescriptor

      public DocumentationDescriptor(DocumentationSupport support, URL source)

    • DocumentationDescriptor

      public DocumentationDescriptor(DocumentationSupport support, Optional<URL> source)
      Creates an instance of a DocumentationDescriptor record class.
      Parameters:
      support - the value for the support record component
      source - the value for the source record component

  • Method Details

    • none

      public static DocumentationDescriptor none()

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

    • support

      public DocumentationSupport support()
      Returns the value of the support record component.
      Returns:
      the value of the support record component

    • source

      public Optional<URL> source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component