bf7fd7a48f47f449afd8c1e45903d8e0b056105d
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / module / ModulePointer.java
1 /*
2  * Copyright 2000-2009 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.NotNull;
19 import org.jetbrains.annotations.Nullable;
20
21 /**
22  * Represents a reliable and efficient reference to (probably non-existing) module by its name. If you have a part of a project configuration
23  * which refers to a module by name, you can store an instance returned by {@link ModulePointerManager#create(String)} instead of storing the module name.
24  * This allows you to get a Module instance via {@link #getModule()} which is more efficient than {@link ModuleManager#findModuleByName}, and
25  * {@link #getModuleName() module name} encapsulated inside the instance will be properly updated if the module it refers to is renamed.
26  */
27 public interface ModulePointer {
28   @Nullable 
29   Module getModule();
30
31   @NotNull
32   String getModuleName();
33 }