BarcodeBuilder.java

package com.demcha.compose.document.dsl;

import com.demcha.compose.document.node.*;
import com.demcha.compose.document.style.DocumentColor;
import com.demcha.compose.document.style.DocumentInsets;
import com.demcha.compose.document.style.DocumentTransform;

import java.awt.*;
import java.util.Objects;

/**
 * Builder for semantic barcode and QR-code nodes.
 *
 * @since 1.0.0
 */
public final class BarcodeBuilder implements Transformable<BarcodeBuilder> {
    private String name = "";
    private String content = "";
    private DocumentBarcodeType type = DocumentBarcodeType.QR_CODE;
    private DocumentColor foreground = DocumentColor.BLACK;
    private DocumentColor background = DocumentColor.WHITE;
    private int quietZoneMargin = 0;
    private double width;
    private double height;
    private DocumentLinkTarget linkTarget;
    private String anchor;
    private DocumentBookmarkOptions bookmarkOptions;
    private DocumentInsets padding = DocumentInsets.zero();
    private DocumentInsets margin = DocumentInsets.zero();
    private DocumentTransform transform = DocumentTransform.NONE;

    /**
     * Creates a barcode builder.
     */
    public BarcodeBuilder() {
    }

    /**
     * Sets the barcode node name.
     *
     * @param name name used in snapshots and layout graph paths
     * @return this builder
     */
    public BarcodeBuilder name(String name) {
        this.name = name == null ? "" : name;
        return this;
    }

    /**
     * Replaces the full barcode options object.
     *
     * @param options canonical barcode options
     * @return this builder
     */
    public BarcodeBuilder options(DocumentBarcodeOptions options) {
        DocumentBarcodeOptions safe = Objects.requireNonNull(options, "options");
        this.content = safe.getContent();
        this.type = safe.getType() == null ? DocumentBarcodeType.QR_CODE : safe.getType();
        this.foreground = safe.getForeground() == null ? DocumentColor.BLACK : safe.getForeground();
        this.background = safe.getBackground() == null ? DocumentColor.WHITE : safe.getBackground();
        this.quietZoneMargin = safe.getQuietZoneMargin();
        return this;
    }

    /**
     * Sets the barcode content.
     *
     * @param content encoded content
     * @return this builder
     */
    public BarcodeBuilder data(String content) {
        this.content = content == null ? "" : content;
        return this;
    }

    /**
     * Sets the barcode type.
     *
     * @param type barcode type
     * @return this builder
     */
    public BarcodeBuilder type(DocumentBarcodeType type) {
        this.type = type == null ? DocumentBarcodeType.QR_CODE : type;
        return this;
    }

    /**
     * Uses QR-code rendering.
     *
     * @return this builder
     */
    public BarcodeBuilder qrCode() {
        return type(DocumentBarcodeType.QR_CODE);
    }

    /**
     * Uses Code 128 barcode rendering.
     *
     * @return this builder
     */
    public BarcodeBuilder code128() {
        return type(DocumentBarcodeType.CODE_128);
    }

    /**
     * Uses Code 39 barcode rendering.
     *
     * @return this builder
     */
    public BarcodeBuilder code39() {
        return type(DocumentBarcodeType.CODE_39);
    }

    /**
     * Uses EAN-13 barcode rendering.
     *
     * @return this builder
     */
    public BarcodeBuilder ean13() {
        return type(DocumentBarcodeType.EAN_13);
    }

    /**
     * Uses EAN-8 barcode rendering.
     *
     * @return this builder
     */
    public BarcodeBuilder ean8() {
        return type(DocumentBarcodeType.EAN_8);
    }

    /**
     * Sets barcode foreground color.
     *
     * @param foreground foreground color
     * @return this builder
     */
    public BarcodeBuilder foreground(Color foreground) {
        return foreground(foreground == null ? null : DocumentColor.of(foreground));
    }

    /**
     * Sets barcode foreground with a public canonical color.
     *
     * @param foreground foreground color
     * @return this builder
     */
    public BarcodeBuilder foreground(DocumentColor foreground) {
        this.foreground = foreground == null ? DocumentColor.BLACK : foreground;
        return this;
    }

    /**
     * Sets barcode background color.
     *
     * @param background background color
     * @return this builder
     */
    public BarcodeBuilder background(Color background) {
        return background(background == null ? null : DocumentColor.of(background));
    }

    /**
     * Sets barcode background with a public canonical color.
     *
     * @param background background color
     * @return this builder
     */
    public BarcodeBuilder background(DocumentColor background) {
        this.background = background == null ? DocumentColor.WHITE : background;
        return this;
    }

    /**
     * Sets barcode quiet-zone margin.
     *
     * @param quietZoneMargin quiet-zone margin in barcode modules
     * @return this builder
     */
    public BarcodeBuilder quietZone(int quietZoneMargin) {
        this.quietZoneMargin = Math.max(0, quietZoneMargin);
        return this;
    }

    /**
     * Sets barcode width.
     *
     * @param width width in points
     * @return this builder
     */
    public BarcodeBuilder width(double width) {
        this.width = width;
        return this;
    }

    /**
     * Sets barcode height.
     *
     * @param height height in points
     * @return this builder
     */
    public BarcodeBuilder height(double height) {
        this.height = height;
        return this;
    }

    /**
     * Sets barcode width and height.
     *
     * @param width  width in points
     * @param height height in points
     * @return this builder
     */
    public BarcodeBuilder size(double width, double height) {
        this.width = width;
        this.height = height;
        return this;
    }

    /**
     * Attaches external link metadata to the barcode.
     *
     * @param linkOptions link metadata
     * @return this builder
     */
    public BarcodeBuilder link(DocumentLinkOptions linkOptions) {
        this.linkTarget = linkOptions == null ? null : new ExternalLinkTarget(linkOptions);
        return this;
    }

    /**
     * Attaches a link target (external URI or internal anchor).
     *
     * @param linkTarget link target, or {@code null} to clear
     * @return this builder
     * @since 1.9.0
     */
    public BarcodeBuilder linkTarget(DocumentLinkTarget linkTarget) {
        this.linkTarget = linkTarget;
        return this;
    }

    /**
     * Makes this element an internal link to a named {@code anchor(...)} elsewhere
     * in the document.
     *
     * @param anchor target anchor name
     * @return this builder
     * @throws IllegalArgumentException if {@code anchor} is blank
     * @since 1.9.0
     */
    public BarcodeBuilder linkTo(String anchor) {
        this.linkTarget = new InternalLinkTarget(anchor);
        return this;
    }

    /**
     * Declares a named in-document navigation anchor at this element's top-left.
     *
     * @param anchor anchor name, or {@code null}/blank to clear
     * @return this builder
     * @since 1.9.0
     */
    public BarcodeBuilder anchor(String anchor) {
        this.anchor = anchor == null || anchor.isBlank() ? null : anchor.trim();
        return this;
    }

    /**
     * Attaches bookmark metadata to the barcode.
     *
     * @param bookmarkOptions bookmark metadata
     * @return this builder
     */
    public BarcodeBuilder bookmark(DocumentBookmarkOptions bookmarkOptions) {
        this.bookmarkOptions = bookmarkOptions;
        return this;
    }

    /**
     * Sets barcode padding with the public canonical spacing value.
     *
     * @param padding padding in points
     * @return this builder
     */
    public BarcodeBuilder padding(DocumentInsets padding) {
        this.padding = padding == null ? DocumentInsets.zero() : padding;
        return this;
    }

    /**
     * Sets barcode margin with the public canonical spacing value.
     *
     * @param margin margin in points
     * @return this builder
     */
    public BarcodeBuilder margin(DocumentInsets margin) {
        this.margin = margin == null ? DocumentInsets.zero() : margin;
        return this;
    }

    /**
     * Sets the render-time affine transform (rotation around the placement
     * centre and/or scaling).
     */
    @Override
    public BarcodeBuilder transform(DocumentTransform transform) {
        this.transform = transform == null ? DocumentTransform.NONE : transform;
        return this;
    }

    @Override
    public DocumentTransform currentTransform() {
        return transform;
    }

    /**
     * Builds the semantic barcode node.
     *
     * @return barcode node
     */
    public BarcodeNode build() {
        DocumentBarcodeOptions options = DocumentBarcodeOptions.builder()
                .content(content)
                .type(type)
                .foreground(foreground)
                .background(background)
                .quietZoneMargin(quietZoneMargin)
                .build();
        return new BarcodeNode(name, options, width, height, linkTarget, bookmarkOptions, padding, margin, transform, anchor);
    }
}

/**
 * Builder for thin horizontal dividers.
 */