001    /*
002     * Copyright 2010-2015 JetBrains s.r.o.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.jetbrains.kotlin.asJava;
018    
019    import com.intellij.openapi.components.ServiceManager;
020    import com.intellij.openapi.project.Project;
021    import com.intellij.psi.PsiClass;
022    import com.intellij.psi.search.GlobalSearchScope;
023    import org.jetbrains.annotations.NotNull;
024    import org.jetbrains.annotations.Nullable;
025    import org.jetbrains.kotlin.name.FqName;
026    import org.jetbrains.kotlin.psi.JetClassOrObject;
027    import org.jetbrains.kotlin.psi.JetFile;
028    
029    import java.util.Collection;
030    
031    public abstract class LightClassGenerationSupport {
032    
033        @NotNull
034        public static LightClassGenerationSupport getInstance(@NotNull Project project) {
035            return ServiceManager.getService(project, LightClassGenerationSupport.class);
036        }
037    
038        @NotNull
039        public abstract LightClassConstructionContext getContextForPackage(@NotNull Collection<JetFile> files);
040    
041        @NotNull
042        public abstract LightClassConstructionContext getContextForClassOrObject(@NotNull JetClassOrObject classOrObject);
043    
044        @NotNull
045        public abstract Collection<JetClassOrObject> findClassOrObjectDeclarations(@NotNull FqName fqName, @NotNull GlobalSearchScope searchScope);
046    
047        /*
048         * Finds files whose package declaration is exactly {@code fqName}. For example, if a file declares
049         *     package a.b.c
050         * it will not be returned for fqName "a.b"
051         *
052         * If the resulting collection is empty, it means that this package has not other declarations than sub-packages
053         */
054        @NotNull
055        public abstract Collection<JetFile> findFilesForPackage(@NotNull FqName fqName, @NotNull GlobalSearchScope searchScope);
056    
057        // Returns only immediately declared classes/objects, package classes are not included (they have no declarations)
058        @NotNull
059        public abstract Collection<JetClassOrObject> findClassOrObjectDeclarationsInPackage(
060                @NotNull FqName packageFqName,
061                @NotNull GlobalSearchScope searchScope
062        );
063    
064        public abstract boolean packageExists(@NotNull FqName fqName, @NotNull GlobalSearchScope scope);
065    
066        @NotNull
067        public abstract Collection<FqName> getSubPackages(@NotNull FqName fqn, @NotNull GlobalSearchScope scope);
068    
069        @Nullable
070        public abstract PsiClass getPsiClass(@NotNull JetClassOrObject classOrObject);
071    
072        @NotNull
073        public abstract Collection<PsiClass> getPackageClasses(@NotNull FqName packageFqName, @NotNull GlobalSearchScope scope);
074    }