replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / vfs / VirtualFilePathWrapper.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.vfs;
17
18 import org.jetbrains.annotations.NotNull;
19
20 /**
21  * For virtual files containing meta information in the path. Like,
22  * {@code x=3746374;y=738495;size=45\id=6729304\id=34343\id=656543}
23  * To wrap such a path into compact form implement getPresentablePath and it
24  * will be used instead of {@code VirtualFile.getPath()}
25  *
26  * @author Konstantin Bulenkov
27  * @see VirtualFile#getPath() 
28  */
29 public interface VirtualFilePathWrapper {
30   @NotNull
31   String getPresentablePath();
32   
33   boolean enforcePresentableName();
34 }