ComponentReference.java

/**
 * Copyright 2011-2012 Universite Joseph Fourier, LIG, ADELE team
 *   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 fr.imag.adele.apam.declarations.references.components;

import fr.imag.adele.apam.declarations.ComponentDeclaration;
import fr.imag.adele.apam.declarations.ComponentKind;
import fr.imag.adele.apam.declarations.references.Reference;
import fr.imag.adele.apam.declarations.references.ResolvableReference;

/**
 * This class represent references to APAM components. They are parameterized by the type of component declaration
 * so that they can be statically typed.
 * 
 * Notice that a component reference can in turn be used as namespace for referencing entities locally declared in
 * the scope of the component declaration;
 * 
 * @author vega
 * 
 */
public class ComponentReference<D extends ComponentDeclaration> extends	Reference implements Reference.Namespace, ResolvableReference {

	/**
	 * The global name space associated with all APAM components.
	 * 
	 * NOTE All APAM declarations share a single name space, this means that even declarations at different
	 * abstraction levels (Specification, Implementation, Instance) must have unique names.
	 */
	private final static Namespace APAM_COMPONENT_NAMESPACE = new Namespace() {
	};

	/**
	 * The name of the component
	 */
	private final String name;

	
	public ComponentReference(String name) {
		super(APAM_COMPONENT_NAMESPACE);
		
		this.name 		= name;
	}

	@Override
	public final String getIdentifier() {
		return getName();
	}

	public ComponentKind getKind() {
		return ComponentKind.COMPONENT;
	}

	public boolean hasSameKindAs(ComponentReference<?> that) {
		return this.getKind().equals(that.getKind());
	}

	/**
	 * The component name
	 */
	@Override
	public final String getName() {
		return name;
	}

}