Class ThumbnailBuilder

java.lang.Object

cloud.opencode.base.image.thumbnail.ThumbnailBuilder

public class ThumbnailBuilder
extends Object

Thumbnail Builder 缩略图构建器

Fluent builder for creating Raster-based thumbnails with size, crop, quality, and format options.

用于创建基于 Raster 的缩略图的流式构建器，支持尺寸、裁剪、质量和格式选项。

Usage Examples | 使用示例:

// Simple thumbnail
ThumbnailBuilder.of(imagePath)
    .size(200, 200)
    .save(thumbnailPath);

// With crop
ThumbnailBuilder.of(imageBytes)
    .size(150, 150)
    .crop(true)
    .quality(0.85f)
    .format(ImageFormat.JPEG)
    .save(outputPath);

Security | 安全性:

• Thread-safe: No (mutable builder) - 线程安全: 否（可变构建器）
• Null-safe: No (throws on null source) - 空值安全: 否（null 源抛异常）

Since:

JDK 25, opencode-base-image V1.0.0

Author:

Leon Soo www.LeonSoo.com

See Also:

• OpenCode.cloud

Constructor Summary

Constructors

Constructor	Description
ThumbnailBuilder()	Empty builder; set the source via source(Path) or source(Raster).
ThumbnailBuilder(Raster source)	Build from a Raster.

Method Summary

Modifier and Type	Method	Description
Raster	build()	Build the thumbnail.
Raster	buildRaster(Raster sourceRaster)	Build a thumbnail from the supplied Raster (overrides any previously configured source).
void	create()	Build the thumbnail and save to the configured output path.
ThumbnailBuilder	crop(boolean crop)
ThumbnailBuilder	format(ImageFormat format)
ThumbnailBuilder	height(int height)
static ThumbnailBuilder	of(byte[] bytes)	Factory: from raw image bytes.
static ThumbnailBuilder	of(Raster raster)	Factory: from Raster.
static ThumbnailBuilder	of(Image image)	Factory: from Image.
static ThumbnailBuilder	of(Path path)	Factory: from path.
ThumbnailBuilder	output(Path path)
ThumbnailBuilder	quality(float quality)
void	save(Path path)	Build and save to path 构建并保存到路径
ThumbnailBuilder	size(int width, int height)
ThumbnailBuilder	source(Raster raster)
ThumbnailBuilder	source(Image image)
ThumbnailBuilder	source(Path path)
byte[]	toBytes()	Build and return as bytes 构建并返回字节数组
Image	toImage()	Build the thumbnail and wrap it in an Image.
ThumbnailBuilder	width(int width)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThumbnailBuilder

public ThumbnailBuilder()

Empty builder; set the source via source(Path) or source(Raster).

ThumbnailBuilder

public ThumbnailBuilder(Raster source)

Build from a Raster.

Method Details

of

public static ThumbnailBuilder of(Path path)
                           throws ImageIOException

Factory: from path.

Throws:

ImageIOException

of

public static ThumbnailBuilder of(Image image)

Factory: from Image.

of

public static ThumbnailBuilder of(Raster raster)

Factory: from Raster.

of

public static ThumbnailBuilder of(byte[] bytes)
                           throws ImageIOException

Factory: from raw image bytes.

Throws:

ImageIOException

size

public ThumbnailBuilder size(int width,
 int height)

width

public ThumbnailBuilder width(int width)

height

public ThumbnailBuilder height(int height)

crop

public ThumbnailBuilder crop(boolean crop)

quality

public ThumbnailBuilder quality(float quality)

format

public ThumbnailBuilder format(ImageFormat format)

source

public ThumbnailBuilder source(Path path)
                        throws ImageIOException

Throws:

ImageIOException

source

public ThumbnailBuilder source(Image image)

source

public ThumbnailBuilder source(Raster raster)

output

public ThumbnailBuilder output(Path path)

create

public void create()
            throws ImageWriteException

Build the thumbnail and save to the configured output path. 构建缩略图并保存到已配置的输出路径。

Throws:

ImageWriteException

build

public Raster build()

Build the thumbnail. 构建缩略图。

Returns:

the thumbnail raster | 缩略图 raster

toImage

public Image toImage()

Build the thumbnail and wrap it in an Image. 构建缩略图并包装为 Image。

save

public void save(Path path)
          throws ImageWriteException

Build and save to path 构建并保存到路径

Throws:

ImageWriteException

toBytes

public byte[] toBytes()
               throws ImageOperationException

Build and return as bytes 构建并返回字节数组

Throws:

ImageOperationException

buildRaster

public Raster buildRaster(Raster sourceRaster)

Build a thumbnail from the supplied Raster (overrides any previously configured source). 使用提供的 Raster 构建缩略图（覆盖已配置的 source）。

Parameters:

sourceRaster - the source raster | 源 raster

Returns:

thumbnail raster | 缩略图 raster

Since:

opencode-base-image V1.0.4