Package io.jmix.dynmodelai.modelchange

Record Class Caption

java.lang.Object
java.lang.Record
io.jmix.dynmodelai.modelchange.Caption
public record Caption(Map<String,String> texts) extends Record
Caption or title texts from the chat by locale. A text given without a locale belongs to the language of the current user.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    USER_LOCALE
    Locale key of a text given without a locale.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Caption(Map<String,String> texts)
    Creates an instance of a Caption record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    covers(Caption other)
    Whether every text of the other caption is kept, in any locale: a requested text survives translation.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Map<String,String>
    messages(String userLocale)
    Messages by locale; a text without a locale is stored for the current user's locale.
    static Caption
    of(String text)
     
    Map<String,String>
    texts()
    Returns the value of the texts record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • Caption

      public Caption(Map<String,String> texts)
      Creates an instance of a Caption record class.
      Parameters:
      texts - the value for the texts record component

  • Method Details

    • of

      public static Caption of(String text)

    • messages

      public Map<String,String> messages(String userLocale)
      Messages by locale; a text without a locale is stored for the current user's locale.

    • covers

      public boolean covers(Caption other)
      Whether every text of the other caption is kept, in any locale: a requested text survives translation.

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

    • texts

      public Map<String,String> texts()
      Returns the value of the texts record component.
      Returns:
      the value of the texts record component