com.amit.api.compiler.model.Function Maven / Gradle / Ivy

Go to download
/******************************************************************************
 * Copyright 20014-2015 Alexandru Motriuc                                     *
 *                                                                            *
 ******************************************************************************
 * Licensed 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 com.amit.api.compiler.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * a function : returnType FunctionName( function args ) throws exceptions;
 */
public class Function extends ProjectElement {
	private UniqueCollection arguments = new UniqueCollection(
			"argument");
	private FunctionReturn returnType;
	private Set throwsExceptions = new HashSet();
	private List throwsExceptionsList = new ArrayList();

	protected Function(String name, Context context, Project project) {
		super(name, context, project);
	}

	/**
	 * returns function arguments
	 * 
	 * @return argument list
	 */
	public List getArguments() {
		return arguments.readonlyList();
	}

	/**
	 * get function return type
	 * 
	 * @return return type
	 */
	public FunctionReturn getReturn() {
		return returnType;
	}

	/**
	 * returns throws exception name list
	 * 
	 * @return exception name list
	 */
	public List getThrowsExceptionNames() {
		return Collections.unmodifiableList(throwsExceptionsList);
	}

	/**
	 * create a function argument
	 * 
	 * @param type
	 * @param name
	 * @param isRequired
	 * @param isMap
	 * @param isArray
	 * @param attr
	 * @param context
	 * @return
	 */
	public FunctionArgument createArgument(String type, String name,
			boolean isRequired, boolean isArray, boolean isMap,
			AttributeList attr, Context context) {

		FunctionArgument arg = new FunctionArgument(type, name, isRequired,
				isArray, isMap, context, getProject());
		arg.setAttributeList(attr);

		arguments.add(arg);
		return arg;
	}

	/**
	 * set function return type
	 * 
	 * @param returnType
	 *            return type
	 */
	public void setReturn(FunctionReturn returnType) {
		if (returnType.getProject() != this.getProject()) {
			throw new IllegalArgumentException(
					"the return type must belong to the project");
		}

		this.returnType = returnType;
	}

	/**
	 * adds throws exception
	 * 
	 * @param exceptionName
	 *            exception name
	 */
	public void addThrowsException(String exceptionName) {
		if (exceptionName == null || exceptionName.isEmpty()) {
			throw new IllegalArgumentException(
					"exceptionName must be not null or empty");
		}

		if (throwsExceptions.contains(exceptionName)) {
			throw new ModuleElementException(String.format(
					"duplicate throws exception for name '%s'", exceptionName),
					this);
		}

		throwsExceptions.add(exceptionName);
		throwsExceptionsList.add(exceptionName);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void validate() throws ModuleElementException {
		super.validate();
		validateArgs();
		validateExceptions();
	}

	private void validateArgs() throws ModuleElementException {
		returnType.validate();
		for (FunctionArgument arg : arguments) {
			arg.validate();
		}
	}

	private void validateExceptions() throws ModuleElementException {
		for (String exception : throwsExceptionsList) {
			validateType(exception, Type.EXCEPTION);
		}
	}
}