Package com.vaadin.hilla.route.records

Record Class ClientViewMenuConfig

java.lang.Object
java.lang.Record
com.vaadin.hilla.route.records.ClientViewMenuConfig
public record ClientViewMenuConfig(String title, Double order, String icon, Boolean exclude) extends Record
Implementation of TypeScript's Hilla ConfigView.Menu. Represents a view's menu configuration from Hilla file-system-routing. Used for configuring MainLayout navigation items

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClientViewMenuConfig(String title, Double order, String icon, Boolean exclude)
    Creates an instance of a ClientViewMenuConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Boolean
    exclude()
    Returns the value of the exclude record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    icon()
    Returns the value of the icon record component.
    Double
    order()
    Returns the value of the order record component.
    String
    title()
    Returns the value of the title 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

  • Constructor Details

    • ClientViewMenuConfig

      public ClientViewMenuConfig(String title, Double order, String icon, Boolean exclude)
      Creates an instance of a ClientViewMenuConfig record class.
      Parameters:
      title - the value for the title record component
      order - the value for the order record component
      icon - the value for the icon record component
      exclude - the value for the exclude 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.

    • title

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

    • order

      public Double order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component

    • icon

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

    • exclude

      public Boolean exclude()
      Returns the value of the exclude record component.
      Returns:
      the value of the exclude record component