Package me.croabeast.prismatic.color

Interface ColorPattern

public interface ColorPattern
Defines a contract for applying and stripping color formatting to strings.

Implementations of ColorPattern are responsible for transforming text by inserting color codes (e.g. for gradients, rainbow effects, or single color changes) and for removing such formatting from text. This is useful in contexts where dynamic text colorization is desired, such as chat messages, GUI displays, or custom logging.

A default list of available color patterns is provided by the constant COLOR_PATTERNS, which includes implementations like MultiColor and SingleColor.

See Also:
  • MultiColor
  • SingleColor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<ColorPattern>
    COLOR_PATTERNS
    A default list of color patterns available for processing text.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    apply(String string, boolean isLegacy)
    Applies the color pattern to the given string.
    @NotNull String
    strip(String string)
    Strips the color formatting applied by this pattern from the given string.

  • Field Details

    • COLOR_PATTERNS

      static final List<ColorPattern> COLOR_PATTERNS
      A default list of color patterns available for processing text.

  • Method Details

    • strip

      @NotNull @NotNull String strip(String string)
      Strips the color formatting applied by this pattern from the given string.

      This method removes any inserted color codes, resulting in a plain text string.

      Parameters:
      string - the text from which to remove color formatting
      Returns:
      the plain text string with all color codes removed

    • apply

      @NotNull @NotNull String apply(String string, boolean isLegacy)
      Applies the color pattern to the given string.

      This method transforms the input text by inserting color codes according to the pattern's rules. The isLegacy flag specifies whether legacy color formatting should be used.

      Parameters:
      string - the input text to which the color pattern will be applied
      isLegacy - true if legacy formatting (e.g. 16-color mode) should be used; false for modern RGB support
      Returns:
      the transformed, colorized string