Record Class TmxPropertyMetadataRegistry.TypeMetadata

java.lang.Object
java.lang.Record
de.gurkenlabs.litiengine.environment.tilemap.TmxPropertyMetadataRegistry.TypeMetadata
Record Components:
typeName - The serialized type identifier.
displayName - The editor-facing type name.
description - The canonical English description.
resourceKey - The optional localization key.
Enclosing class:
TmxPropertyMetadataRegistry
public static record TmxPropertyMetadataRegistry.TypeMetadata(String typeName, String displayName, String description, String resourceKey) extends Record
Documentation and localization metadata for one TMX object type.

  • Constructor Details

    • TypeMetadata

      public TypeMetadata(String typeName, String displayName, String description, String resourceKey)
      Creates an instance of a TypeMetadata record class.
      Parameters:
      typeName - the value for the typeName record component
      displayName - the value for the displayName record component
      description - the value for the description record component
      resourceKey - the value for the resourceKey record component

  • Method Details

    • getTranslatedDescription

      public String getTranslatedDescription()
      Gets the localized description if available, falling back to the canonical English description.
      Returns:
      The localized or canonical description.

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

    • typeName

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

    • displayName

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

    • description

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

    • resourceKey

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