Package com.vaadin.flow.router

Record Class MenuData

java.lang.Object
java.lang.Record
com.vaadin.flow.router.MenuData
All Implemented Interfaces:
Serializable
public record MenuData(String title, Double order, boolean exclude, String icon, Class<? extends Component> menuClass) extends Record implements Serializable
Data class for menu item information.

Only for read as data is immutable.

See Also:

  • Constructor Details

    • MenuData

      @Deprecated(forRemoval=true) public MenuData(String title, Double order, boolean exclude, String icon)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use MenuData(String, Double, boolean, String, Class) instead.
      MenuData constructor.
      Parameters:
      title - title of the menu item
      order - order of the menu item
      exclude - whether the menu item should be excluded
      icon - the icon of the menu item

    • MenuData

      public MenuData(String title, Double order, boolean exclude, String icon, Class<? extends Component> menuClass)
      Creates an instance of a MenuData record class.
      Parameters:
      title - the value for the title record component
      order - the value for the order record component
      exclude - the value for the exclude record component
      icon - the value for the icon record component
      menuClass - the value for the menuClass record component

  • Method Details

    • getTitle

      public String getTitle()
      Gets the title of the menu item.
      Returns:
      the title of the menu item

    • getOrder

      public Double getOrder()
      Gets the order of the menu item.
      Returns:
      the order of the menu item

    • isExclude

      public boolean isExclude()
      Gets whether the menu item should be excluded.
      Returns:
      whether the menu item should be excluded

    • getIcon

      public String getIcon()
      Gets the icon of the menu item.
      Returns:
      the icon of the menu item

    • toString

      public 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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

    • exclude

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

    • icon

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