Top Fields Constructors Methods
io.github.kusoroadeolu.clique.internal

public final Record BoxWrapper

extends Record
Class Inheritance
Annotations
@InternalApi
since:3.2.1
Record Components
width:int 
height:int 
configuration:BoxConfiguration 
wordWrap:List<Cell> 
hLine:String 
vLine:String 
tLeft:String 
tRight:String 
bRight:String 
bLeft:String 
Imports
io.github.kusoroadeolu.clique.configuration.BoxConfiguration, io.github.kusoroadeolu.clique.internal.documentation.InternalApi, java.util.List

Field Summary

Modifier and TypeField and Description
private final String
bLeft

Record Component accessed by bLeft().

private final String
bRight

Record Component accessed by bRight().

private final BoxConfiguration
configuration

Record Component accessed by configuration().

private final int
height

Record Component accessed by height().

private final String
hLine

Record Component accessed by hLine().

private final String
tLeft

Record Component accessed by tLeft().

private final String
tRight

Record Component accessed by tRight().

private final String
vLine

Record Component accessed by vLine().

private final int
width

Record Component accessed by width().

private final List<Cell>
wordWrap

Record Component accessed by wordWrap().

Constructor Summary

AccessConstructor and Description
public
BoxWrapper(int width, int height, BoxConfiguration configuration, List<Cell> wordWrap, String hLine, String vLine, String tLeft, String tRight, String bRight, String bLeft)

Method Summary

Modifier and TypeMethod and Description
public String
bLeft()

Record Component getter of bLeft.

public String
bRight()

Record Component getter of bRight.

public BoxConfiguration
configuration()

Record Component getter of configuration.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public int
height()

Record Component getter of height.

public String
hLine()

Record Component getter of hLine.

public String
tLeft()

Record Component getter of tLeft.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

public String
tRight()

Record Component getter of tRight.

public String
vLine()

Record Component getter of vLine.

public int
width()

Record Component getter of width.

public List<Cell>
wordWrap()

Record Component getter of wordWrap.

Field Detail

bLeftback to summary
private final String bLeft

Record Component accessed by bLeft().

bRightback to summary
private final String bRight

Record Component accessed by bRight().

configurationback to summary
private final BoxConfiguration configuration

Record Component accessed by configuration().

heightback to summary
private final int height

Record Component accessed by height().

hLineback to summary
private final String hLine

Record Component accessed by hLine().

tLeftback to summary
private final String tLeft

Record Component accessed by tLeft().

tRightback to summary
private final String tRight

Record Component accessed by tRight().

vLineback to summary
private final String vLine

Record Component accessed by vLine().

widthback to summary
private final int width

Record Component accessed by width().

wordWrapback to summary
private final List<Cell> wordWrap

Record Component accessed by wordWrap().

Constructor Detail

BoxWrapperback to summary
public BoxWrapper(int width, int height, BoxConfiguration configuration, List<Cell> wordWrap, String hLine, String vLine, String tLeft, String tRight, String bRight, String bLeft)

Method Detail

bLeftback to summary
public String bLeft()

Record Component getter of bLeft.

bRightback to summary
public String bRight()

Record Component getter of bRight.

configurationback to summary
public BoxConfiguration configuration()

Record Component getter of configuration.

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

heightback to summary
public int height()

Record Component getter of height.

hLineback to summary
public String hLine()

Record Component getter of hLine.

tLeftback to summary
public String tLeft()

Record Component getter of tLeft.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

tRightback to summary
public String tRight()

Record Component getter of tRight.

vLineback to summary
public String vLine()

Record Component getter of vLine.

widthback to summary
public int width()

Record Component getter of width.

wordWrapback to summary
public List<Cell> wordWrap()

Record Component getter of wordWrap.