replaced <code></code> with more concise {@code}
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / components / StoragePathMacros.java
1 /*
2  * Copyright 2000-2016 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.components;
17
18 import com.intellij.openapi.project.Project;
19 import org.jetbrains.annotations.NonNls;
20 import org.jetbrains.annotations.NotNull;
21
22 /**
23  * We have a framework for persisting component states (see {@link State} {@link Storage}). It allows to specify which file
24  * should hold persisting data. There is a number of standard file system anchors like 'workspace file', 'project config dir' which
25  * can be used for defining a storage file's path. Hence, IJ provides special support for such anchors in the form of macros,
26  * i.e. special markers that are mapped to the current file system environment at runtime.
27  * <p/>
28  * This class holds those markers and utility method for working with them.
29  *
30  * @author Denis Zhdanov
31  * @since 5/2/12 12:57 PM
32  */
33 public class StoragePathMacros {
34   @Deprecated
35   @NotNull
36   public static final String ROOT_CONFIG = "$ROOT_CONFIG$";
37
38   /**
39    * Points to the application-level options root directory.
40    * @deprecated Not required anymore. See {@link State#storages()}. In short: specify relative path instead (without macro).
41    */
42   @Deprecated
43   public static final String APP_CONFIG = "$APP_CONFIG$";
44
45   /**
46    * @deprecated Not required anymore. See {@link State#storages()}.
47    */
48   @Deprecated
49   public static final String PROJECT_FILE = "$PROJECT_FILE$";
50
51   /**
52    * @deprecated Not required anymore. See {@link State#storages()}.
53    */
54   @Deprecated
55   public static final String PROJECT_CONFIG_DIR = "$PROJECT_CONFIG_DIR$";
56
57   /**
58    * {@link Project#getWorkspaceFile() Workspace} file key.
59    * <p/>
60    * {@code 'Workspace file'} holds settings that are local to a particular environment and should not be shared with another
61    * team members.
62    */
63   @NonNls @NotNull public static final String WORKSPACE_FILE = "$WORKSPACE_FILE$";
64
65   @NonNls @NotNull public static final String MODULE_FILE = "$MODULE_FILE$";
66
67   private StoragePathMacros() {
68   }
69 }