Record Class Heading

java.lang.Object

java.lang.Record

pro.verron.asciidoc.core.Heading

Record Components:

header - AsciiDoc block headers containing optional information

level - heading level (1..6)

inlines - inline fragments

All Implemented Interfaces:

Block

public record Heading(List<String> header, int level, List<Inline> inlines)
extends Record
implements Block

Heading block (levels 1..6).

Constructor Summary

Constructors

Constructor	Description
Heading(int level, List<Inline> inlines)	Constructs a Heading without block headers.
Heading(List<String> header, int level, List<Inline> inlines)	Constructs a Heading with block headers.

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.
List<String>	header()	Returns the value of the header record component.
List<Inline>	inlines()	Returns the value of the inlines record component.
int	level()	Returns the value of the level record component.
int	size()	Returns the content size of this block.
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

Heading

public Heading(int level,
 List<Inline> inlines)

Constructs a Heading without block headers.

Parameters:

level - the heading level, must be between 1 and 6 (inclusive)

inlines - the inline fragments representing the heading content

Throws:

IllegalArgumentException - if the heading level is outside the range 1..6

Heading

public Heading(List<String> header,
 int level,
 List<Inline> inlines)

Constructs a Heading with block headers.

Parameters:

header - header elements, if any

level - the heading level, must be between 1 and 6 (inclusive)

inlines - the inline fragments representing the heading content

Throws:

IllegalArgumentException - if the heading level is outside the range 1..6

Method Details

size

public int size()

Description copied from interface: Block

Returns the content size of this block.

Specified by:

size in interface Block

Returns:

the number of content units in this block

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.

header

public List<String> header()

Returns the value of the header record component.

Returns:

the value of the header record component

level

public int level()

Returns the value of the level record component.

Returns:

the value of the level record component

inlines

public List<Inline> inlines()

Returns the value of the inlines record component.

Returns:

the value of the inlines record component