fr.boreal.io.dlgp.Directive Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integraal-io Show documentation
Inputs and Outputs for integraal objects
The newest version!
/*
 * Copyright (C) Inria Sophia Antipolis - Méditerranée / LIRMM
 * (Université de Montpellier & CNRS) (2014 - 2017)
 *
 * Contributors :
 *
 * Clément SIPIETER 
 * Mélanie KÖNIG
 * Swan ROCHER
 * Jean-François BAGET
 * Michel LECLÈRE
 * Marie-Laure MUGNIER 
 *
 *
 * This file is part of Graal .
 *
 * This software is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software. You can use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty and the software's author, the holder of the
 * economic rights, and the successive licensors have only limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading, using, modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean that it is complicated to manipulate, and that also
 * therefore means that it is reserved for developers and experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and, more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */
package fr.boreal.io.dlgp;

/**
 * @author Clément Sipieter (INRIA) {@literal }
 * 
 * Directives are objects of the DLGP language that are parsed but are not facts, rules or queries.
 */
public record Directive(Type type, Object value) {

	/**
	 * @author Florent Tornil
	 * TYpe of the directive
	 */
	public enum Type {
		/**
		 * Declares a new base (prefix)
		 */
		BASE,
		/**
		 * Declares a new symbol for TOP
		 */
		TOP,
		/**
		 * Declares that the UNA is done
		 */
		UNA,
		/**
		 * Declares a new comment
		 */
		COMMENT,
		/**
		 * Declares a view
		 */
		VIEW
	}

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Creates a new directive with the given type and value
	 *
	 * @param type  type of the directive
	 * @param value value of the directive
	 */
	public Directive {
	}

	// /////////////////////////////////////////////////////////////////////////
	// PUBLIC METHODS
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * @return the type
	 */
	@Override
	public Type type() {
		return type;
	}

	/**
	 * @return the text
	 */
	@Override
	public Object value() {
		return value;
	}

}