com.silanis.esl.sdk.builder.AttachmentRequirementBuilder Maven / Gradle / Ivy

Go to download
package com.silanis.esl.sdk.builder;

import com.silanis.esl.sdk.AttachmentRequirement;
import com.silanis.esl.sdk.internal.Asserts;

/**
 * The AttachmentRequirementBuilder class is a convenient class used to create and customize a AttachmentRequirement
 * associated with a signer.
 */
final public class AttachmentRequirementBuilder {

    private String description;
    private final String name;
    private boolean isRequired;

    /**
     * The constructor of the AttachmentRequirementBuilder class.
     *
     * @param name the attachment name @size(min="1", max="255")
     */
    private AttachmentRequirementBuilder(String name) {
        this.name = name;
    }

    /**
     * Creates a AttachmentRequirementBuilder object.
     *
     * @param name the attachment name @size(min="1", max="255")
     * @return the attachment requirement builder itself
     */
    public static AttachmentRequirementBuilder newAttachmentRequirementWithName(String name) {
        return new AttachmentRequirementBuilder(name);
    }

    /**
     * Sets the attachment's description.
     *
     * @param description the attachment's description @size(max="255")
     * @return the attachment requirement builder itself
     */
    public AttachmentRequirementBuilder withDescription(String description) {
        this.description = description;
        return this;
    }

    /**
     * Sets the isRequired property to true.
     *
     * @return the attachment requirement builder itself
     */
    public AttachmentRequirementBuilder isRequiredAttachment() {
        this.isRequired = true;
        return this;
    }

    /**
     * Builds the actual attachment requirement.
     *
     * @return the attachment requirement
     */
    public AttachmentRequirement build() {
        Asserts.notNullOrEmpty(name, "name");
        AttachmentRequirement attachmentRequirement = new AttachmentRequirement(name);
        attachmentRequirement.setDescription(description);
        attachmentRequirement.setRequired(isRequired);
        attachmentRequirement.setStatus(com.silanis.esl.sdk.RequirementStatus.INCOMPLETE);

        return attachmentRequirement;
    }

}