Package dk.gtz.graphedit.viewmodel

Record Class Tip

java.lang.Object
java.lang.Record
dk.gtz.graphedit.viewmodel.Tip
Record Components:
category - The category of the tip
description - The description / message of the tip
imageWidth - The width of the image to be shown with the tip, ignored if no image is provided.
image - The image to be shown with the tip, optional.
public record Tip(String category, String description, Integer imageWidth, Optional<String> image) extends Record
Represents a tip that can be shown to the user. Note, not to be confused with a Tooltip, this represents a tip object for the TipOfTheDayController view.

  • Constructor Details

    • Tip

      public Tip(String category, String description)
      Creates a new tip with the given category and description.
      Parameters:
      category - The category of the tip
      description - The description / message of the tip

    • Tip

      public Tip(String category, String description, String image)
      Creates a new tip with the given category, description and image.
      Parameters:
      category - The category of the tip
      description - The description / message of the tip
      image - The image to be shown with the tip

    • Tip

      public Tip(String category, String description, Integer imageWidth, String image)
      Creates a new tip with the given category, description and image.
      Parameters:
      category - The category of the tip
      description - The description / message of the tip
      imageWidth - The width of the image to be shown with the tip
      image - The image to be shown with the tip

    • Tip

      public Tip(String category, String description, Integer imageWidth, Optional<String> image)
      Creates an instance of a Tip record class.
      Parameters:
      category - the value for the category record component
      description - the value for the description record component
      imageWidth - the value for the imageWidth record component
      image - the value for the image 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.

    • category

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

    • description

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

    • imageWidth

      public Integer imageWidth()
      Returns the value of the imageWidth record component.
      Returns:
      the value of the imageWidth record component

    • image

      public Optional<String> image()
      Returns the value of the image record component.
      Returns:
      the value of the image record component