Revert "prefer to use JDK utils in low-level classes, do not extend DynamicBundle...
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / libraries / Library.java
1 /*
2  * Copyright 2000-2012 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.roots.libraries;
17
18 import com.intellij.openapi.Disposable;
19 import com.intellij.openapi.roots.OrderRootType;
20 import com.intellij.openapi.roots.ProjectModelElement;
21 import com.intellij.openapi.roots.RootProvider;
22 import com.intellij.openapi.util.JDOMExternalizable;
23 import com.intellij.openapi.util.NlsSafe;
24 import com.intellij.openapi.vfs.VirtualFile;
25 import org.jetbrains.annotations.ApiStatus;
26 import org.jetbrains.annotations.NonNls;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29
30 /**
31  * @author dsl
32  */
33 @ApiStatus.NonExtendable
34 public interface Library extends JDOMExternalizable, Disposable, ProjectModelElement {
35   Library[] EMPTY_ARRAY = new Library[0];
36
37   @Nullable @NlsSafe
38   String getName();
39
40   String @NotNull [] getUrls(@NotNull OrderRootType rootType);
41
42   VirtualFile @NotNull [] getFiles(@NotNull OrderRootType rootType);
43
44   /**
45    * As soon as you obtaining modifiable model you will have to commit it or call Disposer.dispose(model)!
46    */
47   @NotNull
48   ModifiableModel getModifiableModel();
49
50   LibraryTable getTable();
51
52   @NotNull
53   RootProvider getRootProvider();
54
55   boolean isJarDirectory(@NotNull String url);
56
57   boolean isJarDirectory(@NotNull String url, @NotNull OrderRootType rootType);
58
59   boolean isValid(@NotNull String url, @NotNull OrderRootType rootType);
60
61   /**
62    * Compares the content of the current instance of the library with the given one.
63    * @param library to compare with
64    * @return true if the content is same
65    */
66   boolean hasSameContent(@NotNull Library library);
67
68   interface ModifiableModel extends Disposable {
69     String @NotNull [] getUrls(@NotNull OrderRootType rootType);
70
71     void setName(String name);
72
73     String getName();
74
75     void addRoot(@NonNls @NotNull String url, @NotNull OrderRootType rootType);
76
77     void addJarDirectory(@NotNull String url, boolean recursive);
78
79     void addJarDirectory(@NotNull String url, boolean recursive, @NotNull OrderRootType rootType);
80
81     void addRoot(@NotNull VirtualFile file, @NotNull OrderRootType rootType);
82
83     void addJarDirectory(@NotNull VirtualFile file, boolean recursive);
84
85     void addJarDirectory(@NotNull VirtualFile file, boolean recursive, @NotNull OrderRootType rootType);
86
87     void moveRootUp(@NotNull String url, @NotNull OrderRootType rootType);
88
89     void moveRootDown(@NotNull String url, @NotNull OrderRootType rootType);
90
91     boolean removeRoot(@NotNull String url, @NotNull OrderRootType rootType);
92
93     void commit();
94
95     VirtualFile @NotNull [] getFiles(@NotNull OrderRootType rootType);
96
97     boolean isChanged();
98
99     boolean isJarDirectory(@NotNull String url);
100
101     boolean isJarDirectory(@NotNull String url, @NotNull OrderRootType rootType);
102
103     boolean isValid(@NotNull String url, @NotNull OrderRootType rootType);
104   }
105 }