/*
 * Java
 *
 * Copyright 2021-2025 MicroEJ Corp. All rights reserved.
 * This library is provided in source code for use, modification and test, subject to license terms.
 * Any modification of the source code will break MicroEJ Corp. warranties on the whole library.
 */
package ej.microvg;

/**
 * Thrown to indicate that a method has caused an internal VectorGraphics error. This error is specified by an
 * identifier and this identifier can be retrieved calling {@link #getErrorCode()}.
 */
public class VectorGraphicsException extends RuntimeException {

    /**
     * Exception thrown when an image cannot be retrieved. Path must be relative to the application classpath and starts
     * with '/'.
     * <p>
     * Value <code>-1</code> is assigned to <code>IMAGE_INVALID_PATH</code>.
     */
    public static final int IMAGE_INVALID_PATH = -1;

    /**
     * Exception thrown when an image cannot be drawn.
     * <p>
     * Value <code>-2</code> is assigned to <code>IMAGE_INVALID</code>.
     */
    public static final int IMAGE_INVALID = -2;

    /**
     * Exception thrown when an image with overlapping elements is drawn or filtered with a transparent alpha.
     * <p>
     * Value <code>-3</code> is assigned to <code>IMAGE_OVERLAPPING_ELEMENTS</code>.
     */
    public static final int IMAGE_OVERLAPPING_ELEMENTS = -3;

    /**
     * Exception thrown when a font cannot be retrieved. Path must be relative to the application classpath and starts
     * with '/'.
     * <p>
     * Value <code>-4</code> is assigned to <code>FONT_INVALID_PATH</code>.
     */
    public static final int FONT_INVALID_PATH = -4;

    /**
     * Exception thrown when a font cannot be loaded.
     * <p>
     * Value <code>-5</code> is assigned to <code>FONT_INVALID</code>.
     */
    public static final int FONT_INVALID = -5;

    /**
     * Exception thrown when the application is trying to use a resource that has been closed.
     * <p>
     * Value <code>-6</code> is assigned to <code>RESOURCE_CLOSED</code>.
     */
    public static final int RESOURCE_CLOSED = -6;

    /**
     * Exception thrown when an image could not be loaded because of a parsing error.
     * <p>
     * Value <code>-7</code> is assigned to <code>IMAGE_PARSING_ERROR</code>.
     */
    public static final int IMAGE_PARSING_ERROR = -7;

    /**
     * Exception thrown when a font is loaded with complex text layout enabled but no complex layouter is available.
     * <p>
     * Value <code>-8</code> is assigned to <code>NO_COMPLEX_LAYOUTER_ERROR</code>.
     */
    public static final int NO_COMPLEX_LAYOUTER_ERROR = -8;

    /**
     * Exception thrown when an out of memory error occurs.
     * <p>
     * Value <code>-9</code> is assigned to <code>OUT_OF_MEMORY</code>.
     */
    public static final int OUT_OF_MEMORY = -9;

    /**
     * Constructs an exception with the specified error code.
     *
     * @param errorCode
     *            the exception error code
     */
    public VectorGraphicsException(int errorCode) {
        throw new VectorGraphicsException();
    }

    /**
     * Gets the reason why the exception has been thrown.
     *
     * @return the exception error code
     */
    public int getErrorCode() {
        throw new VectorGraphicsException();
    }
    // Constructor only used in API.
}