Record Class ImageWatermark

java.lang.Object
java.lang.Record
cloud.opencode.base.image.watermark.ImageWatermark
Record Components:
image - the watermark image | 水印图片
position - the position | 位置
opacity - the opacity (0.0 to 1.0) | 透明度
margin - the margin from edge | 边缘间距

Features | 主要功能:

  • Immutable image watermark configuration - 不可变的图片水印配置
  • Builder pattern and factory methods - 构建器模式和工厂方法
  • Configurable position, opacity, and margin - 可配置的位置、透明度和边距

Security | 安全性:

  • Thread-safe: Yes (immutable record) - 线程安全: 是（不可变记录）
  • Null-safe: No (image must not be null) - 空值安全: 否（图片不能为 null）
All Implemented Interfaces:
Watermark
public record ImageWatermark(BufferedImage image, Position position, float opacity, int margin) extends Record implements Watermark
Image Watermark 图片水印

Immutable record for image watermark configuration.

图片水印配置的不可变记录。

Usage Examples | 使用示例:

// Simple watermark
ImageWatermark watermark = ImageWatermark.of(logoImage);

// With position
ImageWatermark watermark = ImageWatermark.of(logoImage, Position.BOTTOM_RIGHT);

// With builder
ImageWatermark watermark = ImageWatermark.builder()
    .image(logoImage)
    .position(Position.BOTTOM_RIGHT)
    .opacity(0.8f)
    .margin(20)
    .build();

// With all options
ImageWatermark watermark = new ImageWatermark(logoImage, Position.BOTTOM_RIGHT, 0.5f, 20);
Since:
JDK 25, opencode-base-image V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Field Details

    • 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

    • ImageWatermark

      public ImageWatermark(BufferedImage image, Position position, float opacity, int margin)
      Compact constructor with validation 紧凑构造函数（带验证）

  • Method Details

    • of

      public static ImageWatermark of(BufferedImage image)
      Create simple image watermark 创建简单图片水印
      Parameters:
      image - the watermark image | 水印图片
      Returns:
      the watermark | 水印

    • of

      public static ImageWatermark of(BufferedImage image, Position position)
      Create image watermark with position 创建带位置的图片水印
      Parameters:
      image - the watermark image | 水印图片
      position - the position | 位置
      Returns:
      the watermark | 水印

    • of

      public static ImageWatermark of(BufferedImage image, Position position, float opacity)
      Create image watermark with position and opacity 创建带位置和透明度的图片水印
      Parameters:
      image - the watermark image | 水印图片
      position - the position | 位置
      opacity - the opacity | 透明度
      Returns:
      the watermark | 水印

    • getWidth

      public int getWidth()
      Get watermark width 获取水印宽度
      Returns:
      the width | 宽度

    • getHeight

      public int getHeight()
      Get watermark height 获取水印高度
      Returns:
      the height | 高度

    • withPosition

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

    • withOpacity

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

    • withMargin

      public ImageWatermark withMargin(int newMargin)
      Create copy with different margin 创建使用不同边距的副本
      Parameters:
      newMargin - the new margin | 新边距
      Returns:
      new watermark | 新水印

    • withImage

      public ImageWatermark withImage(BufferedImage newImage)
      Create copy with different image 创建使用不同图片的副本
      Parameters:
      newImage - the new image | 新图片
      Returns:
      new watermark | 新水印

    • builder

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

    • builder

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

    • 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.

    • image

      public BufferedImage image()
      Returns the value of the image record component.
      Returns:
      the value of the image 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

    • 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