Record Class TextWatermark

java.lang.Object
java.lang.Record
cloud.opencode.base.image.watermark.TextWatermark
Record Components:
text - the watermark text (non-empty) | 水印文字（非空）
position - the position | 位置
fontFamily - the font family / name (informational; resolved by caller) | 字体族 / 名称（仅信息性，由调用方解析）
fontSize - the font pixel height | 字体像素高度
colorArgb - the text color, packed ARGB | 文字颜色（打包 ARGB）
opacity - the opacity (0.0 to 1.0) | 透明度（0.0 到 1.0）
margin - the margin from edge | 边缘间距

Security | 安全性:

  • Thread-safe: Yes (immutable record) - 线程安全: 是（不可变记录）
  • Null-safe: text/position must not be null - 空值安全: text/position 不能为 null
All Implemented Interfaces:
Watermark
public record TextWatermark(String text, Position position, String fontFamily, int fontSize, int colorArgb, float opacity, int margin) extends Record implements Watermark
Text Watermark 文字水印

Immutable record describing a text watermark. Font is identified by family name and pixel size only — actual rasterization is done by the caller via cloud.opencode.base.image.codec.font.Font.rasterize(text, pixelHeight), which returns the Bitmap that must be passed to apply(Raster, Bitmap). Color is a packed ARGB int.

描述文字水印的不可变 record。字体仅由名称和像素大小标识 —— 实际光栅化由调用方 通过 Font.rasterize(text, pixelHeight) 完成，返回的 Bitmap 传给 apply(Raster, Bitmap)。颜色为打包 ARGB int。

Usage Examples | 使用示例:

// Simple watermark
TextWatermark watermark = TextWatermark.of("Copyright 2024");

// With position and ARGB color
TextWatermark watermark = TextWatermark.builder()
    .text("© 2024 Company")
    .position(Position.BOTTOM_RIGHT)
    .fontFamily("Arial")
    .fontSize(24)
    .colorArgb(0xFFFFFFFF)
    .opacity(0.8f)
    .build();
Since:
JDK 25, opencode-base-image V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Field Details

    • DEFAULT_FONT_FAMILY

      public static final String DEFAULT_FONT_FAMILY
      Default font family | 默认字体族
      See Also:

    • DEFAULT_FONT_SIZE

      public static final int DEFAULT_FONT_SIZE
      Default font pixel size | 默认字体像素大小
      See Also:

    • DEFAULT_COLOR_ARGB

      public static final int DEFAULT_COLOR_ARGB
      Default color (white, alpha=180/255) | 默认颜色（白色，alpha=180/255）
      See Also:

    • DEFAULT_OPACITY

      public static final float DEFAULT_OPACITY
      Default opacity | 默认透明度
      See Also:

    • DEFAULT_MARGIN

      public static final int DEFAULT_MARGIN
      Default margin | 默认边距
      See Also:

  • Constructor Details

    • TextWatermark

      public TextWatermark(String text, Position position, String fontFamily, int fontSize, int colorArgb, float opacity, int margin)
      Compact constructor with validation 紧凑构造函数（带验证）

  • Method Details

    • of

      public static TextWatermark of(String text)
      Create simple text watermark 创建简单文字水印
      Parameters:
      text - the watermark text | 水印文字
      Returns:
      the watermark | 水印

    • of

      public static TextWatermark of(String text, Position position)
      Create text watermark with position 创建带位置的文字水印
      Parameters:
      text - the watermark text | 水印文字
      position - the position | 位置
      Returns:
      the watermark | 水印

    • builder

      public static TextWatermark.Builder builder()
      Create a builder 创建构建器
      Returns:
      the builder | 构建器

    • builder

      public static TextWatermark.Builder builder(TextWatermark watermark)
      Create a builder from existing watermark 从现有水印创建构建器
      Parameters:
      watermark - the existing watermark | 现有水印
      Returns:
      the builder | 构建器

    • withText

      public TextWatermark withText(String newText)
      Create copy with different text 创建使用不同文字的副本
      Parameters:
      newText - the new text | 新文字
      Returns:
      new watermark | 新水印

    • withPosition

      public TextWatermark withPosition(Position newPosition)
      Create copy with different position 创建使用不同位置的副本
      Parameters:
      newPosition - the new position | 新位置
      Returns:
      new watermark | 新水印

    • withOpacity

      public TextWatermark withOpacity(float newOpacity)
      Create copy with different opacity 创建使用不同透明度的副本
      Parameters:
      newOpacity - the new opacity | 新透明度
      Returns:
      new watermark | 新水印

    • apply

      public Raster apply(Raster raster, Bitmap textBitmap)
      Apply this text watermark on a Raster using a pre-rasterized text alpha Bitmap. 使用预先光栅化的 alpha Bitmap 在 Raster 上应用此文字水印。

      The Bitmap can be produced via cloud.opencode.base.image.codec.font.Font.rasterize(text, pixelHeight), which replaces the legacy AWT TextLayout + (pure-Java) pipeline.

      Bitmap 可通过 Font.rasterize(text, pixelHeight) 获得， 替代旧的 AWT TextLayout + (pure-Java) 管线。

      Parameters:
      raster - target raster | 目标 raster
      textBitmap - pre-rasterized text alpha bitmap | 预光栅化的文字 alpha 位图
      Returns:
      watermarked RGBA_8 raster | 加水印的 RGBA_8 raster
      Throws:
      NullPointerException - if any argument is null | 任意参数为 null 时抛出
      Since:
      opencode-base-image V1.0.4

    • applyTiled

      public Raster applyTiled(Raster raster, Bitmap textBitmap, int spacingX, int spacingY)
      Tile this text watermark across a Raster using a pre-rasterized text alpha Bitmap. 使用预光栅化的 alpha Bitmap 在 Raster 上平铺此文字水印。
      Parameters:
      raster - target raster | 目标 raster
      textBitmap - pre-rasterized text alpha bitmap | 预光栅化的文字 alpha 位图
      spacingX - horizontal spacing | 水平间距
      spacingY - vertical spacing | 垂直间距
      Returns:
      tiled-watermarked RGBA_8 raster | 平铺水印后的 RGBA_8 raster
      Throws:
      NullPointerException - if any argument is null | 任意参数为 null 时抛出
      Since:
      opencode-base-image V1.0.4

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • position

      public Position position()
      Returns the value of the position record component.
      Specified by:
      position in interface Watermark
      Returns:
      the value of the position record component

    • fontFamily

      public String fontFamily()
      Returns the value of the fontFamily record component.
      Returns:
      the value of the fontFamily record component

    • fontSize

      public int fontSize()
      Returns the value of the fontSize record component.
      Returns:
      the value of the fontSize record component

    • colorArgb

      public int colorArgb()
      Returns the value of the colorArgb record component.
      Returns:
      the value of the colorArgb record component

    • opacity

      public float opacity()
      Returns the value of the opacity record component.
      Specified by:
      opacity in interface Watermark
      Returns:
      the value of the opacity record component

    • margin

      public int margin()
      Returns the value of the margin record component.
      Specified by:
      margin in interface Watermark
      Returns:
      the value of the margin record component