PDFFlavour.java

/**
 * This file is part of veraPDF Parser, a module of the veraPDF project.
 * Copyright (c) 2015-2025, veraPDF Consortium <info@verapdf.org>
 * All rights reserved.
 *
 * veraPDF Parser is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with veraPDF Parser as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * veraPDF Parser as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.parser;

import java.util.List;

public enum PDFFlavour {
	NO_FLAVOUR(Specification.NO_STANDARD),
	PDFA_1_A(Specification.ISO_19005_1),
	PDFA_1_B(Specification.ISO_19005_1),
	PDFA_2_A(Specification.ISO_19005_2),
	PDFA_2_B(Specification.ISO_19005_2),
	PDFA_2_U(Specification.ISO_19005_2),
	PDFA_3_A(Specification.ISO_19005_3),
	PDFA_3_B(Specification.ISO_19005_3),
	PDFA_3_U(Specification.ISO_19005_3),
	PDFA_4(Specification.ISO_19005_4),
	PDFA_4_F(Specification.ISO_19005_4),
	PDFA_4_E(Specification.ISO_19005_4),
	PDFUA_1(Specification.ISO_14289_1),
	PDFUA_2(Specification.ISO_14289_2),
	WTPDF_1_0_REUSE(Specification.WTPDF_1_0),
	WTPDF_1_0_ACCESSIBILITY(Specification.WTPDF_1_0),
	WCAG_2_1(Specification.WCAG_2_1),
	WCAG_2_2_MACHINE(Specification.WCAG_2_2),
	WCAG_2_2_HUMAN(Specification.WCAG_2_2),
	WCAG_2_2_PDF_2_0_MACHINE(Specification.WCAG_2_2_PDF_2_0),
	WCAG_2_2_PDF_2_0_HUMAN(Specification.WCAG_2_2_PDF_2_0),
	NO_ARLINGTON_FLAVOUR(Specification.NO_STANDARD),
	ARLINGTON1_0(Specification.PDF_1_0),
	ARLINGTON1_1(Specification.PDF_1_1),
	ARLINGTON1_2(Specification.PDF_1_2),
	ARLINGTON1_3(Specification.PDF_1_3),
	ARLINGTON1_4(Specification.PDF_1_4),
	ARLINGTON1_5(Specification.PDF_1_5),
	ARLINGTON1_6(Specification.PDF_1_6),
	ARLINGTON1_7(Specification.ISO_32000_1_7),
	ARLINGTON2_0(Specification.ISO_32000_2_0);

	private final Specification specification;

	private PDFFlavour(final Specification specification) {
		this.specification = specification;
	}

	public Specification getSpecification() {
		return specification;
	}

	public enum Specification {
		NO_STANDARD(SpecificationFamily.NONE, PDFSpecification.NO_SPECIFICATION),
		ISO_14289_1(SpecificationFamily.PDF_UA, PDFSpecification.ISO_32000_1_7),
		ISO_14289_2(SpecificationFamily.PDF_UA, PDFSpecification.ISO_32000_2_0),
		ISO_19005_1(SpecificationFamily.PDF_A, PDFSpecification.PDF_REFERENCE_1_4),
		ISO_19005_2(SpecificationFamily.PDF_A, PDFSpecification.ISO_32000_1_7),
		ISO_19005_3(SpecificationFamily.PDF_A, PDFSpecification.ISO_32000_1_7),
		ISO_19005_4(SpecificationFamily.PDF_A, PDFSpecification.ISO_32000_2_0),
		WTPDF_1_0(SpecificationFamily.WTPDF, PDFSpecification.ISO_32000_2_0),
		WCAG_2_1(SpecificationFamily.WCAG, PDFSpecification.ISO_32000_2_0),
		WCAG_2_2(SpecificationFamily.WCAG, PDFSpecification.ISO_32000_1_7),
		WCAG_2_2_PDF_2_0(SpecificationFamily.WCAG, PDFSpecification.ISO_32000_2_0),
		PDF_1_0(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_0),
		PDF_1_1(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_1),
		PDF_1_2(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_2),
		PDF_1_3(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_3),
		PDF_1_4(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_4),
		PDF_1_5(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_5),
		PDF_1_6(SpecificationFamily.ARLINGTON, PDFSpecification.PDF_REFERENCE_1_6),
		ISO_32000_1_7(SpecificationFamily.ARLINGTON, PDFSpecification.ISO_32000_1_7),
		ISO_32000_2_0(SpecificationFamily.ARLINGTON, PDFSpecification.ISO_32000_2_0);

		private final SpecificationFamily family;
		private final PDFSpecification pdfSpecification;

		Specification(final SpecificationFamily family, final PDFSpecification pdfSpecification) {
			this.family = family;
			this.pdfSpecification = pdfSpecification;
		}
		
		public SpecificationFamily getFamily() {
			return family;
		}

		public PDFSpecification getPdfSpecification() {
			return pdfSpecification;
		}
	}
	
	public enum SpecificationFamily {
		NONE,
		PDF_A,
		PDF_UA,
		WCAG,
		WTPDF,
		ARLINGTON
	}

	public enum PDFSpecification {
		NO_SPECIFICATION,
		PDF_REFERENCE_1_0,
		PDF_REFERENCE_1_1,
		PDF_REFERENCE_1_2,
		PDF_REFERENCE_1_3,
		PDF_REFERENCE_1_4,
		PDF_REFERENCE_1_5,
		PDF_REFERENCE_1_6,
		ISO_32000_1_7,
		ISO_32000_2_0
	}

	public static boolean isFlavourPDFSpecification(List<PDFFlavour> flavours, PDFSpecification pdfSpecification) {
		for (PDFFlavour flavour : flavours) {
			if (isFlavourPDFSpecification(flavour, pdfSpecification)) {
				return true;
			}
		}
		return false;
	}
	
	public static boolean isFlavourPDFSpecification(PDFFlavour flavour, PDFSpecification pdfSpecification) {
		return flavour != null && flavour.getSpecification().getPdfSpecification() == pdfSpecification;
	}

	public static boolean isFlavourFamily(List<PDFFlavour> flavours, SpecificationFamily specificationFamily) {
		for (PDFFlavour flavour : flavours) {
			if (isFlavourFamily(flavour, specificationFamily)) {
				return true;
			}
		}
		return false;
	}

	public static boolean isFlavourFamily(PDFFlavour flavour, SpecificationFamily specificationFamily) {
		return flavour != null && flavour.getSpecification().getFamily() == specificationFamily;
	}

	public static boolean isFlavour(PDFFlavour currentFlavour, PDFFlavour flavour) {
		return currentFlavour != null && currentFlavour == flavour;
	}

	public static boolean isFlavourPart(List<PDFFlavour> flavours, Specification specificationPart) {
		for (PDFFlavour flavour : flavours) {
			if (isFlavourPart(flavour, specificationPart)) {
				return true;
			}
		}
		return false;
	}

	public static boolean isFlavourPart(PDFFlavour flavour, Specification specificationPart) {
		return flavour != null && flavour.getSpecification() == specificationPart;
	}

	public static boolean isPDFUA2RelatedFlavour(List<PDFFlavour> flavours) {
		for (PDFFlavour flavour : flavours) {
			if (isPDFUA2RelatedFlavour(flavour)) {
				return true;
			}
		}
		return false;
	}

	public static boolean isPDFUA2RelatedFlavour(PDFFlavour flavour) {
		return isFlavour(flavour, PDFFlavour.PDFUA_2) || isFlavourPart(flavour, Specification.WTPDF_1_0);
	}
}