SModelListener.java

/*
 * Copyright 2003-2011 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jetbrains.mps.smodel.event;

import jetbrains.mps.smodel.loading.ModelLoadingState;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.mps.openapi.model.SModel;

/**
 * Author: Sergey Dmitriev
 * Created Sep 16, 2003
 * <p/>
 * WARNING: Do not use this kind of listener in UI. In case of changes to a model
 * that affect many nodes it might lead to performance problems.
 * In these cases use {@link SModelCommandListener} which listens to batch notifications
 */
public interface SModelListener {
  void languageAdded(SModelLanguageEvent event);

  void languageRemoved(SModelLanguageEvent event);

  void importAdded(SModelImportEvent event);

  void importRemoved(SModelImportEvent event);

  void devkitAdded(SModelDevKitEvent event);

  void devkitRemoved(SModelDevKitEvent event);

  /**
   * @deprecated use {@link org.jetbrains.mps.openapi.model.SModelChangeListener#nodeAdded}
   */
  @Deprecated
  void rootAdded(SModelRootEvent event);

  /**
   * @deprecated use {@link org.jetbrains.mps.openapi.model.SModelChangeListener#nodeRemoved}
   */
  @Deprecated
  void rootRemoved(SModelRootEvent event);

  void beforeRootRemoved(SModelRootEvent event);

  void beforeModelRenamed(SModelRenamedEvent event);

  void modelRenamed(SModelRenamedEvent event);

  void beforeModelFileChanged(SModelFileChangedEvent event);

  void modelFileChanged(SModelFileChangedEvent event);

  void propertyChanged(SModelPropertyEvent event);

  void childAdded(SModelChildEvent event);

  void childRemoved(SModelChildEvent event);

  void beforeChildRemoved(SModelChildEvent event);

  void referenceAdded(SModelReferenceEvent event);

  void referenceRemoved(SModelReferenceEvent event);

  void modelSaved(SModel sm);

  void modelLoadingStateChanged(SModel sm, ModelLoadingState newState);

  void beforeModelDisposed(SModel sm);

  @NotNull
  SModelListenerPriority getPriority();

  public enum SModelListenerPriority {
    PLATFORM,
    CLIENT
  }
}