blob: 37442322569486e73bf978c9e8baf70bea5e5e60 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.openapi.components;
import com.intellij.openapi.project.Project;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
/**
* We have a framework for persisting component states (see {@link State} {@link Storage}). It allows to specify which file
* should hold persisting data. There is a number of standard file system anchors like 'workspace file', 'project config dir' which
* can be used for defining a storage file's path. Hence, IJ provides special support for such anchors in the form of macros,
* i.e. special markers that are mapped to the current file system environment at runtime.
* <p/>
* This class holds those markers and utility method for working with them.
*
* @author Denis Zhdanov
* @since 5/2/12 12:57 PM
*/
public class StoragePathMacros {
@NonNls @NotNull public static final String ROOT_CONFIG = "$ROOT_CONFIG$";
/** Points to the application-level settings root directory. */
@NonNls @NotNull public static final String APP_CONFIG = "$APP_CONFIG$";
/** <code>'.ipr'</code> file path key. */
@NonNls @NotNull public static final String PROJECT_FILE = "$PROJECT_FILE$";
/** <code>'.idea'</code> directory path key. */
@NonNls @NotNull public static final String PROJECT_CONFIG_DIR = "$PROJECT_CONFIG_DIR$";
/**
* {@link Project#getWorkspaceFile() Workspace} file key.
* <p/>
* <code>'Workspace file'</code> holds settings that are local to a particular environment and should not be shared with another
* team members.
*/
@NonNls @NotNull public static final String WORKSPACE_FILE = "$WORKSPACE_FILE$";
private StoragePathMacros() {
}
/**
* Allows to extract macro name from the given macro definition.
* <p/>
* Basically, performs conversion like {@code '$NAME$' -> 'NAME'}.
*
* @param macro macro definition which name should be extracted.
* @return name of the given macro definition
* @throws IllegalArgumentException if given macro definition has unexpected format
*/
@NotNull
public static String getMacroName(@NotNull String macro) throws IllegalArgumentException {
if (macro.length() < 3 || macro.charAt(0) != '$' || macro.charAt(macro.length() - 1) != '$') {
throw new IllegalArgumentException("Malformed macro definition (" + macro + ")");
}
return macro.substring(1, macro.length() - 1);
}
}
|
