/* * 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. *
* 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 { /** Points to the application-level settings root directory. */ @NonNls @NotNull public static final String APP_CONFIG = "$APP_CONFIG$"; /**'.ipr'
file path key. */
@NonNls @NotNull public static final String PROJECT_FILE = "$PROJECT_FILE$";
/** '.idea'
directory path key. */
@NonNls @NotNull public static final String PROJECT_CONFIG_DIR = "$PROJECT_CONFIG_DIR$";
/**
* {@link Project#getWorkspaceFile() Workspace} file key.
*
* 'Workspace file'
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.
*
* 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);
}
}