Package org.refcodes.textual

Interface TextLineBuilder

  • All Superinterfaces:
    org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<TextLineBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty
    All Known Implementing Classes:
    TextLineBuilderImpl

    public interface TextLineBuilder
extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<TextLineBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty
    Creates a text line with the given character and width. In conjunction with the SystemUtility.getTerminalWidth() method, you can create lines consuming the full width of your terminal.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.ColumnWidthAccessor

        org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      char getLineChar​()
      Retrieves the line char from the line char property.
      void setLineChar​(char aLineChar)
      Sets the line char for the line char property.
      java.lang.String toString​()
      The String being build by the builder upon the settings of the attributes.
      default java.lang.String toString​(int aLength, char aFillChar)
      Returns a String with the given length and containing only the provided fill character.
      default TextLineBuilder withLineChar​(char aLineChar)
      Sets the line char for the line char property.

      • Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

        getColumnWidth

      • Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder

        withColumnWidth

      • Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator

        setColumnWidth

    • Method Detail

      • getLineChar

        char getLineChar​()
        Retrieves the line char from the line char property.
        Returns:
        The line char stored by the line char property.

      • setLineChar

        void setLineChar​(char aLineChar)
        Sets the line char for the line char property.
        Parameters:
        aLineChar - The line char to be stored by the line char property.

      • withLineChar

        default TextLineBuilder withLineChar​(char aLineChar)
        Sets the line char for the line char property.
        Parameters:
        aLineChar - The line char to be stored by the line char property.
        Returns:
        The builder for applying multiple build operations.

      • toString

        java.lang.String toString​()
        The String being build by the builder upon the settings of the attributes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The according resulting String

      • toString

        default java.lang.String toString​(int aLength,
                                  char aFillChar)
        Returns a String with the given length and containing only the provided fill character.
        Parameters:
        aLength - The length to be reached.
        aFillChar - The char to be used for filling up
        Returns:
        The String filled with the fill character till the provided length.