Record Class RendererMetadata

java.lang.Object
java.lang.Record
com.arbergashi.charts.render.RendererMetadata
Record Components:
id - unique renderer id used for lookup/registration
nameKey - i18n key for the renderer display name
iconPath - classpath resource path to an SVG icon (e.g. "/icons/line.svg")
public record RendererMetadata(String id, String nameKey, String iconPath) extends Record
Stable public renderer metadata.

This lightweight value object is intended for UI discovery, navigation trees, and general introspection in consuming applications. It intentionally contains only stable identifiers and resource keys, not factories or Swing types.

Framework contract: This type is part of the public API and will remain backwards compatible across 1.x releases.

Since:
2025-06-17
Version:
1.0.0
Author:
Arber Gashi

  • Constructor Details

    • RendererMetadata

      public RendererMetadata(String id, String nameKey, String iconPath)
      Creates an instance of a RendererMetadata record class.
      Parameters:
      id - the value for the id record component
      nameKey - the value for the nameKey record component
      iconPath - the value for the iconPath 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. 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.

    • id

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

    • nameKey

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

    • iconPath

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