PHPType.java

/*******************************************************************************
 * Copyright (c) 2013-2014 The PDT Extension Group (https://github.com/pdt-eg)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 ******************************************************************************/
package org.pdtextensions.core;

import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.dltk.core.IType;
import org.eclipse.dltk.core.ITypeHierarchy;
import org.eclipse.dltk.core.ModelException;
import org.eclipse.php.internal.core.typeinference.PHPModelUtils;
import org.pdtextensions.core.util.PDTModelUtils;

/**
 * This class provides information about the type as a PHP class, interface, trait, and namespace.
 *
 * @since 0.20.0
 */
public class PHPType {
	private final static String NAMESPACE_SEPARATOR = "\\"; //$NON-NLS-1$
	private IType type;

	public PHPType(IType type) {
		Assert.isNotNull(type);

		this.type = type;
	}

	public boolean inResourceWithSameName() throws CoreException {
		return PDTModelUtils.inResourceWithSameName(type.getResource(), type.getElementName());
	}

	public boolean equals(IType type) {
		return equals(type.getTypeQualifiedName(NAMESPACE_SEPARATOR));
	}

	@Override
	public boolean equals(Object obj) {
		if (obj instanceof PHPType) {
			return equals(((PHPType) obj).type);
		} else {
			return false;
		}
	}

	public boolean equals(String typeName) {
		return type.getTypeQualifiedName(NAMESPACE_SEPARATOR).equals(typeName);
	}

	public boolean isInstanceOf(IType type) throws ModelException {
		return isInstanceOf(PHPModelUtils.getFullName(type));
	}

	public boolean isInstanceOf(String typeName) throws ModelException {
		if (equals(typeName)) {
			return true;
		} else {
			ITypeHierarchy hierarchy = type.newSupertypeHierarchy(new NullProgressMonitor());
			if (hierarchy == null) return false;
			IType[] superTypes = hierarchy.getAllSuperclasses(type);
			if (superTypes == null) return false;

			for (IType variableSuperType: superTypes) {
				if (new PHPType(variableSuperType).equals(typeName)) {
					return true;
				}
			}
		}

		return false;
	}
}