Package org.coordinatekit.crf.cli

Interface Banner.Product

Enclosing class:
Banner
public static interface Banner.Product
A tool's product identity: the wordmark art in two sizes plus the accent color its name is painted in. Public so a launcher in any package can build one; the implementation is a private record, and fromResources(java.lang.Class<?>, java.lang.String, java.lang.String, int, int, int) is the factory.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    accentBlue()
    The blue component of the accent color, 0-255.
    int
    accentGreen()
    The green component of the accent color, 0-255.
    int
    accentRed()
    The red component of the accent color, 0-255.
    List<String>
    bigArt()
    The large wordmark art, one string per row.
    static Banner.Product
    fromResources(Class<?> anchor, String bigResource, String smallResource, int accentRed, int accentGreen, int accentBlue)
    Loads a product from two classpath art resources.
    List<String>
    smallArt()
    The small wordmark art, one string per row.

  • Method Details

    • fromResources

      static Banner.Product fromResources(Class<?> anchor, String bigResource, String smallResource, int accentRed, int accentGreen, int accentBlue)
      Loads a product from two classpath art resources.
      Parameters:
      anchor - the class whose package the resource names resolve against
      bigResource - the resource name of the large wordmark art, relative to anchor
      smallResource - the resource name of the small wordmark art, relative to anchor
      accentRed - the red component of the accent color, 0-255
      accentGreen - the green component of the accent color, 0-255
      accentBlue - the blue component of the accent color, 0-255
      Returns:
      the product backed by the loaded art

    • accentBlue

      int accentBlue()
      The blue component of the accent color, 0-255.
      Returns:
      the blue component of the accent color

    • accentGreen

      int accentGreen()
      The green component of the accent color, 0-255.
      Returns:
      the green component of the accent color

    • accentRed

      int accentRed()
      The red component of the accent color, 0-255.
      Returns:
      the red component of the accent color

    • bigArt

      List<String> bigArt()
      The large wordmark art, one string per row.
      Returns:
      the large wordmark art

    • smallArt

      List<String> smallArt()
      The small wordmark art, one string per row.
      Returns:
      the small wordmark art