Record Class ControlPanel.Category

java.lang.Object

java.lang.Record

io.micronaut.controlpanel.core.ControlPanel.Category

Record Components:

id - category id, used in links.

name - category name, displayed in the menu.

iconClass - category icon class, displayed in the menu.

order - category order, used to sort the menu items.

Enclosing interface:

ControlPanel<B>

public static record ControlPanel.Category(String id, String name, String iconClass, Integer order)
extends Record

Control panels are grouped by category. Categories are used to render the menu items of the control panel UI.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field	Description
static final ControlPanel.Category	MAIN

Constructor Summary

Constructors

Constructor	Description
Category(String id, String name, String iconClass)
Category(String id, String name, String iconClass, Integer order)	Creates an instance of a Category record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	iconClass()	Returns the value of the iconClass record component.
String	id()	Returns the value of the id record component.
String	name()	Returns the value of the name record component.
Integer	order()	Returns the value of the order record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MAIN

public static final ControlPanel.Category MAIN

Constructor Details

Category

public Category(String id,
 String name,
 String iconClass)

Category

public Category(String id,
 String name,
 String iconClass,
 Integer order)

Creates an instance of a Category record class.

Parameters:

id - the value for the id record component

name - the value for the name record component

iconClass - the value for the iconClass record component

order - the value for the order 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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

iconClass

public String iconClass()

Returns the value of the iconClass record component.

Returns:

the value of the iconClass record component

order

public Integer order()

Returns the value of the order record component.

Returns:

the value of the order record component