Record Class MacroBlock

java.lang.Object

java.lang.Record

pro.verron.asciidoc.core.MacroBlock

Record Components:

header - an ordered list of strings associated with the macro

name - the macro name

id - the unique identifier for the macro

All Implemented Interfaces:

Block

public record MacroBlock(List<String> header, String name, String id)
extends Record
implements Block

Block-level macro in an AsciiDoc document.

Constructor Summary

Constructors

Constructor	Description
MacroBlock(List<String> header, String name, String id)	Creates an instance of a MacroBlock record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	attribute(String name)	Returns the value of the named attribute from the header.
Map<String,String>	attributes()	Parses the header list into a key-value attribute map.
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.
String	id()	Returns the value of the id record component.
String	name()	Returns the value of the name 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

MacroBlock

public MacroBlock(List<String> header,
 String name,
 String id)

Creates an instance of a MacroBlock record class.

Parameters:

header - the value for the header record component

name - the value for the name record component

id - the value for the id record component

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

attribute

public Optional<String> attribute(String name)

Returns the value of the named attribute from the header.

Parameters:

name - attribute name

Returns:

attribute value, or null if absent

attributes

public Map<String,String> attributes()

Parses the header list into a key-value attribute map.

Returns:

attribute map parsed from key="value" entries in the header

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.

header

public List<String> header()

Returns the value of the header record component.

Returns:

the value of the header record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component