/*
 * Copyright 2007-2013
 * Licensed under GNU Lesser General Public License
 * 
 * This file is part of EpochX: genetic programming software for research
 * 
 * EpochX 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 3 of the License, or
 * (at your option) any later version.
 * 
 * EpochX 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 EpochX. If not, see <http://www.gnu.org/licenses/>.
 * 
 * The latest version is available from: http://www.epochx.org
 */
package org.epochx.epox.bool;

import org.epochx.epox.Node;
import org.epochx.tools.DataTypeUtils;

/**
 * A node which performs logical negation
 * 
 * @since 2.0
 */
public class Not extends Node {

    public static final String IDENTIFIER = "NOT";

	/**
	 * Constructs a <code>NotFunction</code> with one <code>null</code> child
	 */
	public Not() {
		this(null);
	}

	/**
	 * Constructs a <code>NotFunction</code> with one boolean child node
	 * 
	 * @param child the first child node
	 */
	public Not(Node child) {
		super(child);
	}

	/**
	 * Evaluates this function. The child node is evaluated, the result of which
	 * must be a <code>Boolean</code> instance. The result is negated and returned 
	 * as the result.
	 * 
	 * @return <code>true</code> if the child evaluates to <code>false</code>, 
	 * 			otherwise <code>false</code>
	 */
	@Override
	public Boolean evaluate() {
		return !((Boolean) getChild(0).evaluate()).booleanValue();
	}

	/**
	 * Returns the identifier of this function which is <code>NOT</code>
	 * 
	 * @return this node's identifier
	 */
	@Override
	public String getIdentifier() {
		return IDENTIFIER;
	}

	/**
	 * Returns this function node's return type for the given child input types.
	 * If there is one child with a return type of <code>Boolean</code>, then the 
	 * return type of this function will also be <code>Boolean</code>. In all other 
	 * cases this method will return <code>null</code> to indicate that the inputs 
	 * are invalid.
	 * 
	 * @return the <code>Boolean</code> class or <code>null</code> if the input type is 
	 * invalid
	 */
	@Override
	public Class<?> dataType(Class<?> ... inputTypes) {
		if ((inputTypes.length == 1) && DataTypeUtils.allEqual(inputTypes, Boolean.class)) {
			return Boolean.class;
		} else {
			return null;
		}
	}
}