com.pdftools.pdfa.conversion.EventSeverity 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.
The newest version!
/****************************************************************************
 *
 * File:            EventSeverity.java
 *
 * Description:     EventSeverity 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.pdfa.conversion;

/**
 * The severity of conversion events
 * See {@link Converter.ConversionEventListener } for more information on conversion events.
 */
public enum EventSeverity  
{
    /**
     * A conversion event which is of an informational nature
     * 
     * An informational event requires no further action.
     * 
     * By default events of the following {@link EventCategory } are classified as {@link EventSeverity#INFORMATION }:
     * 

     * 
     * {@link EventCategory#MANAGED_COLORS }
     * 
     * {@link EventCategory#CHANGED_COLORANT }
     * 
     * {@link EventCategory#REMOVED_EXTERNAL_CONTENT }
     * 
     * {@link EventCategory#CONVERTED_FONT }
     * 
     * {@link EventCategory#SUBSTITUTED_FONT }
     * 
     * {@link EventCategory#REMOVED_ANNOTATION }
     * 
     * {@link EventCategory#REMOVED_MULTIMEDIA }
     * 
     * {@link EventCategory#REMOVED_ACTION }
     * 
     * {@link EventCategory#REMOVED_METADATA }
     * 
     * {@link EventCategory#REMOVED_STRUCTURE }
     * 
     * {@link EventCategory#CONVERTED_EMBEDDED_FILE }
     * 
     * {@link EventCategory#REMOVED_SIGNATURE }
     * 

     */
    INFORMATION(1),
    /**
     * A conversion event which is generally considered a non-critical issue
     * 
     * An warning that might require further actions.
     * 
     * By default events of the following {@link EventCategory } are classified as {@link EventSeverity#WARNING }:
     * 

     * 
     * {@link EventCategory#VISUAL_DIFFERENCES }
     * 
     * {@link EventCategory#REPAIRED_CORRUPTION }
     * 
     * {@link EventCategory#REMOVED_TRANSPARENCY } (PDF/A-1 only)
     * 
     * {@link EventCategory#REMOVED_EMBEDDED_FILE }  (PDF/A-1 and PDF/A-2 only)
     * 
     * {@link EventCategory#REMOVED_OPTIONAL_CONTENT } (PDF/A-1 only)
     * 

     */
    WARNING(2),
    /**
     * A conversion event which is generally considered a critical issue
     * 
     * A critical issue for which the conversion must be considered as failed.
     * 
     * By default no event uses this severity.
     * 
     */
    ERROR(3);

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

    /**
     * @hidden
     */
    public static EventSeverity fromValue(int value) 
    {
        switch (value) 
        {
            case 1: return INFORMATION;
            case 2: return WARNING;
            case 3: return ERROR;
        }
        throw new IllegalArgumentException("Unknown value for EventSeverity: " + value);
    }

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

    private int value;
}