fac4e5e9edb14ec2d5ec88bf91b7df37661255fa
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / application / PathMacros.java
1 /*
2  * Copyright 2000-2014 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.application;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import org.jetbrains.annotations.NotNull;
20
21 import java.util.Collection;
22 import java.util.Set;
23
24 public abstract class PathMacros {
25   public static PathMacros getInstance() {
26     return ServiceManager.getService(PathMacros.class);
27   }
28
29   public abstract Set<String> getAllMacroNames();
30
31   public abstract String getValue(String name);
32
33   public abstract void setMacro(String name, String value);
34
35   /**
36    * Obsolete macros that are to be removed gently from the project files. They can be read, but not written again. Not persisted
37    */
38   public abstract void addLegacyMacro(@NotNull String name, @NotNull String value);
39
40   public abstract void removeMacro(String name);
41
42   public abstract Set<String> getUserMacroNames();
43
44   public abstract Set<String> getSystemMacroNames();
45
46   public abstract Collection<String> getIgnoredMacroNames();
47
48   public abstract void setIgnoredMacroNames(@NotNull final Collection<String> names);
49
50   public abstract void addIgnoredMacro(@NotNull final String name);
51
52   public abstract boolean isIgnoredMacroName(@NotNull final String macro);
53
54   public abstract void removeAllMacros();
55
56   public abstract Collection<String> getLegacyMacroNames();
57 }