com.pdftools.pdf.Permission Maven / Gradle / Ivy

Go to download

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

The Pdftools SDK is a comprehensive development library that lets developers integrate advanced PDF functionalities into in-house applications.

There is a newer version: 1.8.0

Show newest version

/****************************************************************************
 *
 * File:            Permission.java
 *
 * Description:     Permission Enumeration
 *
 * Author:          PDF Tools AG
 * 
 * Copyright:       Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
 *                  All rights reserved.
 * 
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 ***************************************************************************/

package com.pdftools.pdf;

import com.pdftools.internal.Flag;
import java.util.EnumSet;

/**
 * The permissions allowed by a PDF document
 * 
 * 
 * See {@link Document#getPermissions } to read the permissions of a PDF document.
 * 
 * See {@link OutputOptions#getEncryption } to set the permissions when encrypting a PDF document.
 * 
 */
public enum Permission implements Flag 
{
    /**
     * Allow low resolution printing.
     */
    PRINT(4),
    /**
     * Allow changing the document.
     */
    MODIFY(8),
    /**
     * Allow content copying or extraction.
     */
    COPY(16),
    /**
     * Allow annotations.
     */
    ANNOTATE(32),
    /**
     * Allow filling of form fields.
     */
    FILL_FORMS(256),
    /**
     * Allow support for disabilities.
     */
    SUPPORT_DISABILITIES(512),
    /**
     * Allow document assembly.
     */
    ASSEMBLE(1024),
    /**
     * Allow high resolution printing.
     */
    DIGITAL_PRINT(2048);
    /**
     * No permission.
     */
    public static final EnumSet NONE = EnumSet.noneOf(Permission.class);
    /**
     * All Permission.
     */
    public static final EnumSet ALL = EnumSet.allOf(Permission.class);

    Permission(int value) 
    {
        this.value = value;
    }

    /**
     * @hidden
     */
    public int getFlag() 
    {
        return value;
    }

    private int value;
}