Record Class Cheatsheet

java.lang.Object

java.lang.Record

io.micronaut.jsonschema.generator.ref.Cheatsheet

Record Components:

editor - An editor to modify cheatsheets
https://github.com/cheat/cheat#cheatpaths

colorize - Whether cheatsheets should be colorized
https://github.com/cheat/cheat#cheatpaths

style - A color schema applied for cheatsheets
https://github.com/cheat/cheat#cheatpaths

formatter - A formatter to format cheatsheets
https://github.com/cheat/cheat#cheatpaths

pager - A pager to read long cheatsheets
https://github.com/cheat/cheat#cheatpaths

cheatpaths - Cheatpaths
https://github.com/cheat/cheat#cheatpaths

public record Cheatsheet(Object editor, boolean colorize, Cheatsheet.Style style, Cheatsheet.Formatter formatter, Object pager, List<Cheatsheet.Cheatpaths> cheatpaths)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Cheatsheet.Cheatpaths	A cheatpath https://github.com/cheat/cheat#cheatpaths
static enum	Cheatsheet.Formatter	A formatter to format cheatsheets https://github.com/cheat/cheat#cheatpaths
static enum	Cheatsheet.Style	A color schema applied for cheatsheets https://github.com/cheat/cheat#cheatpaths

Constructor Summary

Constructors

Constructor	Description
Cheatsheet(Object editor, boolean colorize, Cheatsheet.Style style, Cheatsheet.Formatter formatter, Object pager, List<Cheatsheet.Cheatpaths> cheatpaths)	Creates an instance of a Cheatsheet record class.

Method Summary

Modifier and Type	Method	Description
List<Cheatsheet.Cheatpaths>	cheatpaths()	Returns the value of the cheatpaths record component.
boolean	colorize()	Returns the value of the colorize record component.
Object	editor()	Returns the value of the editor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Cheatsheet.Formatter	formatter()	Returns the value of the formatter record component.
final int	hashCode()	Returns a hash code value for this object.
Object	pager()	Returns the value of the pager record component.
Cheatsheet.Style	style()	Returns the value of the style 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

Constructor Details

Cheatsheet

public Cheatsheet(Object editor,
 boolean colorize,
 Cheatsheet.Style style,
 Cheatsheet.Formatter formatter,
 Object pager,
 List<Cheatsheet.Cheatpaths> cheatpaths)

Creates an instance of a Cheatsheet record class.

Parameters:

editor - the value for the editor record component

colorize - the value for the colorize record component

style - the value for the style record component

formatter - the value for the formatter record component

pager - the value for the pager record component

cheatpaths - the value for the cheatpaths 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

editor

public Object editor()

Returns the value of the editor record component.

Returns:

the value of the editor record component

colorize

public boolean colorize()

Returns the value of the colorize record component.

Returns:

the value of the colorize record component

style

public Cheatsheet.Style style()

Returns the value of the style record component.

Returns:

the value of the style record component

formatter

public Cheatsheet.Formatter formatter()

Returns the value of the formatter record component.

Returns:

the value of the formatter record component

pager

public Object pager()

Returns the value of the pager record component.

Returns:

the value of the pager record component

cheatpaths

public List<Cheatsheet.Cheatpaths> cheatpaths()

Returns the value of the cheatpaths record component.

Returns:

the value of the cheatpaths record component