bc377945d581264f3a3afac0c2da89891893340a
[idea/community.git] / platform / platform-api / src / com / intellij / util / Url.java
1 /*
2  * Copyright 2000-2015 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.util;
17
18 import org.jetbrains.annotations.NotNull;
19 import org.jetbrains.annotations.Nullable;
20
21 // We don't use Java URI due to problem - http://cns-etuat-2.localnet.englishtown.com/school/e12/#school/45383/201/221/382?c=countrycode=cc|culturecode=en-us|partnercode=mkge
22 // it is illegal URI (fragment before query), but we must support such URI
23 // Semicolon as parameters separator is supported (WEB-6671)
24 public interface Url {
25   /**
26    * System-independent path
27    */
28   @NotNull
29   String getPath();
30
31   boolean isInLocalFileSystem();
32
33   String toDecodedForm();
34
35   @NotNull
36   String toExternalForm();
37
38   @Nullable
39   String getScheme();
40
41   @Nullable
42   String getAuthority();
43
44   @Nullable
45   String getParameters();
46
47   boolean equalsIgnoreParameters(@Nullable Url url);
48
49   boolean equalsIgnoreCase(@Nullable Url url);
50
51   @NotNull
52   Url trimParameters();
53
54   int hashCodeCaseInsensitive();
55 }