com.intellij.execution.Location.java Source code

Introduction

Here is the source code for com.intellij.execution.Location.java

Source

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * 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.intellij.execution;

import com.intellij.openapi.actionSystem.DataKey;
import com.intellij.openapi.fileEditor.OpenFileDescriptor;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Iterator;

public abstract class Location<E extends PsiElement> {
    public static final DataKey<Location<?>> DATA_KEY = DataKey.create("Location");
    @Deprecated
    @NonNls
    public static final String LOCATION = DATA_KEY.getName();

    @NotNull
    public abstract E getPsiElement();

    @NotNull
    public abstract Project getProject();

    @NotNull
    public abstract <T extends PsiElement> Iterator<Location<T>> getAncestors(Class<T> ancestorClass,
            boolean strict);

    @Nullable
    public VirtualFile getVirtualFile() {
        final E psiElement = getPsiElement();
        if (!psiElement.isValid())
            return null;
        final PsiFile psiFile = psiElement.getContainingFile();
        if (psiFile == null)
            return null;
        final VirtualFile virtualFile = psiFile.getVirtualFile();
        if (virtualFile == null || !virtualFile.isValid())
            return null;
        return virtualFile;
    }

    @Nullable
    public OpenFileDescriptor getOpenFileDescriptor() {
        VirtualFile virtualFile = getVirtualFile();
        if (virtualFile == null) {
            return null;
        }
        return new OpenFileDescriptor(getProject(), virtualFile, getPsiElement().getTextOffset());
    }

    @Nullable
    public <Ancestor extends PsiElement> Location<Ancestor> getParent(final Class<Ancestor> parentClass) {
        final Iterator<Location<PsiElement>> ancestors = getAncestors(PsiElement.class, true);
        if (!ancestors.hasNext())
            return null;
        final Location<? extends PsiElement> parent = ancestors.next();
        if (parentClass.isInstance(parent.getPsiElement()))
            return (Location<Ancestor>) parent;
        return null;
    }

    @Nullable
    public <T extends PsiElement> Location<T> getAncestorOrSelf(final Class<T> ancestorClass) {
        final Iterator<Location<T>> ancestors = getAncestors(ancestorClass, false);
        if (!ancestors.hasNext())
            return null;
        return ancestors.next();
    }

    @Nullable
    public <Ancestor extends PsiElement> Ancestor getParentElement(final Class<Ancestor> parentClass) {
        return safeGetPsiElement(getParent(parentClass));
    }

    @Nullable
    public static <T extends PsiElement> T safeGetPsiElement(final Location<T> location) {
        return location != null ? location.getPsiElement() : null;
    }

    @Nullable
    public static <T> T safeCast(final Object obj, final Class<T> expectedClass) {
        if (expectedClass.isInstance(obj))
            return (T) obj;
        return null;
    }

    @NotNull
    public PsiLocation<E> toPsiLocation() {
        return new PsiLocation<E>(getProject(), getPsiElement());
    }

    @Nullable
    public abstract Module getModule();
}