platform/lang-api/src/com/intellij/openapi/roots/libraries/Library.java

   1 /*
   2  * Copyright 2000-2009 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.RootProvider;
  21 import com.intellij.openapi.util.JDOMExternalizable;
  22 import com.intellij.openapi.vfs.VirtualFile;
  23 import org.jetbrains.annotations.NotNull;
  24
  25 /**
  26  *  @author dsl
  27  */
  28 public interface Library extends JDOMExternalizable, Disposable {
  29   String getName();
  30
  31   @NotNull String[] getUrls(@NotNull OrderRootType rootType);
  32
  33   @NotNull VirtualFile[] getFiles(@NotNull OrderRootType rootType);
  34
  35   /**
  36    * As soon as you obtaining modifiable model you will have to commit it or call Disposer.dispose(model)!
  37    */
  38   @NotNull ModifiableModel getModifiableModel();
  39
  40   LibraryTable getTable();
  41
  42   @NotNull RootProvider getRootProvider();
  43
  44   boolean isJarDirectory(@NotNull String url);
  45
  46   boolean isValid(@NotNull String url, @NotNull OrderRootType rootType);
  47
  48   interface ModifiableModel extends Disposable {
  49     @NotNull String[] getUrls(@NotNull OrderRootType rootType);
  50
  51     void setName(@NotNull String name);
  52
  53     String getName();
  54
  55     void addRoot(@NotNull String url, @NotNull OrderRootType rootType);
  56
  57     void addJarDirectory(@NotNull String url, boolean recursive);
  58
  59     void addRoot(@NotNull VirtualFile file, @NotNull OrderRootType rootType);
  60
  61     void addJarDirectory(@NotNull VirtualFile file, boolean recursive);
  62
  63     void moveRootUp(@NotNull String url, @NotNull OrderRootType rootType);
  64
  65     void moveRootDown(@NotNull String url, @NotNull OrderRootType rootType);
  66
  67     boolean removeRoot(@NotNull String url, @NotNull OrderRootType rootType);
  68
  69     void commit();
  70
  71     @NotNull VirtualFile[] getFiles(@NotNull OrderRootType rootType);
  72
  73     boolean isChanged();
  74
  75     boolean isJarDirectory(@NotNull String url);
  76
  77     boolean isValid(@NotNull String url, @NotNull OrderRootType rootType);
  78   }
  79 }