platform/lang-api/src/com/intellij/openapi/projectRoots/SdkModel.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.projectRoots;
  17
  18 import org.jetbrains.annotations.Nullable;
  19
  20 import java.util.EventListener;
  21
  22 /**
  23  * Represents the current state of the JDK list in the JDK and Global Libraries
  24  * configuration dialog.
  25  */
  26 public interface SdkModel {
  27
  28   /**
  29    * Returns the list of SDKs in the table.
  30    * @return the SDK list.
  31    */
  32   Sdk[] getSdks();
  33
  34   /**
  35    * Returns the SDK with the specified name, or null if one is not found.
  36    *
  37    * @param sdkName the name of the SDK to find.
  38    * @return the SDK instance or null.
  39    */
  40   @Nullable
  41   Sdk findSdk(String sdkName);
  42
  43   /**
  44    * Allows to receive notifications when the JDK list has been changed by the
  45    * user configuring the JDKs.
  46    */
  47
  48   interface Listener extends EventListener {
  49     /**
  50      * Called when a JDK has been added.
  51      *
  52      * @param sdk the added JDK.
  53      */
  54     void sdkAdded(Sdk sdk);
  55
  56     /**
  57      * Called before a JDK is removed.
  58      *
  59      * @param sdk the removed JDK.
  60      */
  61     void beforeSdkRemove(Sdk sdk);
  62
  63     /**
  64      * Called when a JDK has been changed or renamed.
  65      *
  66      * @param sdk          the changed or renamed JDK.
  67      * @param previousName the old name of the changed or renamed JDK.
  68      * @since 5.0.1
  69      */
  70     void sdkChanged(Sdk sdk, String previousName);
  71
  72     /**
  73      * Called when the home directory of a JDK has been changed.
  74      * @param sdk        the changed JDK.
  75      * @param newSdkHome the new home directory.
  76      */
  77     void sdkHomeSelected(Sdk sdk, String newSdkHome);
  78
  79   }
  80
  81   /**
  82    * Adds a listener for receiving notifications about changes in the list.
  83    *
  84    * @param listener the listener instance.
  85    */
  86   void addListener(Listener listener);
  87
  88   /**
  89    * Removes a listener for receiving notifications about changes in the list.
  90    *
  91    * @param listener the listener instance.
  92    */
  93   void removeListener(Listener listener);
  94 }