com.adobe.pdfservices.operation.pdfjobs.params.deletepages.DeletePagesParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pdfservices-sdk Show documentation

Adobe PDF Services SDK allows you to access RESTful APIs to create, convert, and manipulate PDFs within your applications. Older versions can be found under groupId: com.adobe.documentservices, artifactId: pdftools-sdk

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright 2024 Adobe
 * All Rights Reserved.
 *
 * NOTICE: Adobe permits you to use, modify, and distribute this file in
 * accordance with the terms of the Adobe license agreement accompanying
 * it. If you have received this file from a source other than Adobe,
 * then your use, modification, or distribution of it requires the prior
 * written permission of Adobe.
 */

package com.adobe.pdfservices.operation.pdfjobs.params.deletepages;

import com.adobe.pdfservices.operation.internal.constants.CustomErrorMessages;
import com.adobe.pdfservices.operation.internal.util.ObjectUtil;
import com.adobe.pdfservices.operation.internal.util.ValidationUtil;
import com.adobe.pdfservices.operation.pdfjobs.jobs.DeletePagesJob;
import com.adobe.pdfservices.operation.pdfjobs.params.PDFServicesJobParams;
import com.adobe.pdfservices.operation.pdfjobs.params.PageRanges;

/**
 * Parameters for deleting pages from a pdf using {@link DeletePagesJob}.
 */
public class DeletePagesParams implements PDFServicesJobParams {

    private PageRanges pageRanges;

    /**
     * Creates an instance of {@link DeletePagesParams} with the given {@link PageRanges}.
     *
     * @param pageRanges the {@link PageRanges} to be used for deleting pages; can not be null.
     */
    public DeletePagesParams(PageRanges pageRanges) {
        ObjectUtil.requireNonNull(pageRanges, String.format(CustomErrorMessages.GENERIC_CAN_NOT_BE_NULL, "Page " +
                "Ranges"));
        ValidationUtil.validatePageRanges(pageRanges);
        this.pageRanges = pageRanges;
    }

    /**
     * Returns the {@link PageRanges} to be used for deleting pages.
     *
     * @return the {@link PageRanges} to be used for deleting pages.
     */
    public PageRanges getPageRanges() {
        return pageRanges;
    }
}