com.adobe.pdfservices.operation.pdfjobs.params.protectpdf.ContentEncryption Maven / Gradle / Ivy

Go to download
/*
 * 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.protectpdf;

import com.adobe.pdfservices.operation.pdfjobs.jobs.ProtectPDFJob;

/**
 * Supported types of content to encrypt for {@link ProtectPDFJob}
 */
public enum ContentEncryption {

    /**
     * Encrypts all the content of the PDF file
     */
    ALL_CONTENT("ALL_CONTENT"),

    /**
     * Encrypts all the content except the metadata of the PDF file
     */
    ALL_CONTENT_EXCEPT_METADATA("ALL_CONTENT_EXCEPT_METADATA"),

    /**
     * Encrypts only embedded files
     */
    ONLY_EMBEDDED_FILES("ONLY_EMBEDDED_FILES");

    private final String value;

    /**
     * Constructor.
     *
     * @param value type of content to encrypt
     */
    ContentEncryption(String value) {
        this.value = value;
    }

    /**
     * Returns the value of the type of content to encrypt
     *
     * @return string value of the type of content to encrypt
     */
    public String getValue() {
        return value;
    }
}