Flag.java

/*
 * #%L
 * prolobjectlink-jpi-jtrolog
 * %%
 * Copyright (C) 2012 - 2018 WorkLogic Project
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
 * #L%
 */
/*
 * tuProlog - Copyright (C) 2001-2002  aliCE team at deis.unibo.it
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package jTrolog.terms;

/**
 * This class represents a prolog Flag
 */
@SuppressWarnings("serial")
public class Flag implements java.io.Serializable {

	private String name;
	private Struct valueList;
	private Term value;
	private boolean modifiable;

	/**
	 * Builds a Prolog flag
	 * 
	 * @param name
	 *            is the name of the flag
	 * @param valueSet
	 *            is the Prolog list of the possible values
	 * @param defValue
	 *            is the default value
	 * @param modifiable
	 *            states if the flag is modifiable
	 */
	public Flag(String name, Struct valueSet, Term defValue, boolean modifiable) {
		this.name = name;
		this.valueList = valueSet;
		this.modifiable = modifiable;
		value = defValue;
	}

	/**
	 * @return the name of the flag
	 */
	public String getName() {
		return name;
	}

	/**
	 * @return a Prolog list of the flag's possible values
	 */
	public Struct getValueList() {
		return valueList;
	}

	/**
	 * Sets the value of a flag
	 * 
	 * @param value
	 *            new value of the flag
	 */
	public void setValue(Term value) {
		if (modifiable)
			this.value = value;
	}

	/**
	 * @return the current value of the flag
	 */
	public Term getValue() {
		return value;
	}

	/**
	 * @return true if the value is modifiable
	 */
	public boolean isModifiable() {
		return modifiable;
	}
}