platform/core-api/src/com/intellij/openapi/module/ModuleDescription.java

   1 /*
   2  * Copyright 2000-2017 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.openapi.module;
  17
  18 import org.jetbrains.annotations.ApiStatus;
  19 import org.jetbrains.annotations.NotNull;
  20
  21 import java.util.List;
  22
  23 /**
  24  * Represents a description of a module which may be either loaded into the project or unloaded. Use this class only if you need to process
  25  * all modules including unloaded, in other cases {@link Module} should be used instead.
  26  *
  27  * @see UnloadedModuleDescription
  28  * @see LoadedModuleDescription
  29  * @author nik
  30  */
  31 @ApiStatus.Experimental
  32 public interface ModuleDescription {
  33   @NotNull
  34   String getName();
  35
  36   /**
  37    * Names of the modules on which the current module depend.
  38    */
  39   @NotNull
  40   List<String> getDependencyModuleNames();
  41 }