/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 ****************************************************************/
package org.apache.cayenne.exp.parser;

import org.apache.cayenne.exp.Expression;
import org.apache.cayenne.util.ConversionUtil;

/**
 * Bitwise negation (NOT i.e. inventor or '~') operation .
 * 
 * @since 3.1
 */
public class ASTBitwiseNot extends EvaluatedNode {
	private static final long serialVersionUID = 1L;

	ASTBitwiseNot(int id) {
		super(id);
	}

	public ASTBitwiseNot() {
		super(ExpressionParserTreeConstants.JJTBITWISENOT);
	}

	public ASTBitwiseNot(Object node) {
        super(ExpressionParserTreeConstants.JJTBITWISENOT);
        jjtAddChild(wrapChild(node), 0);
        connectChildren();
	}

	@Override
	protected Object evaluateSubNode(Object o, Object[] evaluatedChildren) throws Exception {
		long value = ConversionUtil.toLong(o, Long.MIN_VALUE);
		if (value == Long.MIN_VALUE) {
			return null;
		}
		return ~value;
	}

	@Override
	protected int getRequiredChildrenCount() {
		return 1;
	}

	@Override
	protected String getExpressionOperator(int index) {
		return "~";
	}
	
	@Override
	public int getType() {
		return Expression.BITWISE_NOT;
	}

	@Override
	protected String getEJBQLExpressionOperator(int index) {
		throw new UnsupportedOperationException(
				"EJBQL 'bitwise not' is not supported");
	}

	@Override
	public Expression shallowCopy() {
		return new ASTBitwiseNot(id);
	}
}