JavaParameter.java

/*
 * Copyright (C) 2009 by Claas Wilke (claaswilke@gmx.net) This file is part of
 * the Java Meta Model of Dresden OCL2 for Eclipse. Dresden OCL2 for Eclipse 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. Dresden OCL2 for Eclipse 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 Dresden OCL2 for Eclipse. If
 * not, see <http://www.gnu.org/licenses/>.
 */
package org.dresdenocl.metamodels.java.internal.model;

import java.lang.reflect.Method;

import org.apache.log4j.Logger;

import org.dresdenocl.metamodels.java.JavaMetaModelPlugin;
import org.dresdenocl.pivotmodel.Operation;
import org.dresdenocl.pivotmodel.Parameter;
import org.dresdenocl.pivotmodel.ParameterDirectionKind;
import org.dresdenocl.pivotmodel.Type;
import org.dresdenocl.pivotmodel.base.AbstractParameter;

/**
 * <p>
 * An implementation of the Pivot Model {@link Parameter} concept for Java.
 * </p>
 * 
 * @author Claas Wilke
 */
public class JavaParameter extends AbstractParameter implements Parameter {

	/** The {@link Logger} for this class. */
	private static final Logger LOGGER =
			JavaMetaModelPlugin.getLogger(JavaParameter.class);

	/** The adapted {@link Class} of this {@link JavaParameter}. */
	private Class<?> myClass;

	/**
	 * The adapted {@link java.lang.reflect.Type} of this {@link JavaParameter}.
	 */
	private java.lang.reflect.Type myGenericType;

	/** The {@link Operation} of this {@link JavaParameter}. */
	private Method myMethod;

	/** The {@link ParameterDirectionKind} of this {@link JavaParameter}. */
	private ParameterDirectionKind myKind;

	/**
	 * The {@link JavaParameter} has a number used to create a unique parameter
	 * name.
	 */
	private int myParameterNumber;

	/** The {@link JavaAdapterFactory} the {@link JavaParameter} belongs to. */
	private JavaAdapterFactory myFactory;

	/**
	 * <p>
	 * Creates a new {@link JavaParameter} instance.
	 * </p>
	 * 
	 * @param dslParameter
	 *          The {@link Class} that is adopted by this class.
	 * @param genericParameter
	 *          The generic {@link java.lang.reflect.Type} of this
	 *          {@link JavaParameter} or <code>null</code>.
	 * @param parameterKind
	 *          The {@link ParameterDirectionKind} of this {@link JavaParameter}.
	 * @param method
	 *          The {@link Method} of this {@link JavaParameter}.
	 * @param parameterNumber
	 *          A number used to create a unique parameter name.
	 * @param aFactory
	 *          The {@link JavaAdapterFactory}, the new created
	 *          {@link JavaParameter} shall belong to.
	 */
	public JavaParameter(Class<?> dslParameter,
			java.lang.reflect.Type genericParameter,
			ParameterDirectionKind parameterKind, Method method, int parameterNumber,
			JavaAdapterFactory aFactory) {

		/* Eventually log the entry of this method. */
		if (LOGGER.isDebugEnabled()) {
			String msg;

			msg = "JavaParameter(";
			msg += ", dslParameter = " + dslParameter;
			msg += ", genericParameter = " + genericParameter;
			msg += ", parameterKind = " + parameterKind;
			msg += ", method = " + method;
			msg += ", parameterNumber = " + parameterNumber;
			msg += ", aFactory = " + aFactory;
			msg += ") - enter";

			LOGGER.debug(msg); //$NON-NLS-1$
		}

		/* Initialize adapted parameters. */
		this.myClass = dslParameter;
		this.myGenericType = genericParameter;
		this.myKind = parameterKind;
		this.myMethod = method;
		this.myParameterNumber = parameterNumber;
		this.myFactory = aFactory;

		/* Eventually log the exit of this method. */
		if (LOGGER.isDebugEnabled()) {
			LOGGER.debug("JavaParameter() - exit"); //$NON-NLS-1$
		}
		// no else.
	}

	/*
	 * (non-Javadoc)
	 * @see org.dresdenocl.pivotmodel.impl.ParameterImpl#getKind()
	 */
	public ParameterDirectionKind getKind() {

		return this.myKind;
	}

	/*
	 * (non-Javadoc)
	 * @see org.dresdenocl.pivotmodel.base.AbstractParameter#getName()
	 */
	@Override
	public String getName() {

		return this.getKind().toString() + this.myParameterNumber;
	}

	/*
	 * (non-Javadoc)
	 * @see org.dresdenocl.pivotmodel.base.AbstractParameter#getOperation()
	 */
	@Override
	public Operation getOperation() {

		return this.myFactory.createOperation(this.myMethod);
	}

	/*
	 * (non-Javadoc)
	 * @see org.dresdenocl.pivotmodel.base.AbstractParameter#getType()
	 */
	@Override
	public Type getType() {

		return this.myFactory.adaptJavaType(this.myClass, this.myGenericType);
	}
}