blaze-base/src/com/google/idea/blaze/base/sync/SyncListener.java

/*
 * Copyright 2016 The Bazel Authors. All rights reserved.
 *
 * 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 com.google.idea.blaze.base.sync;

import com.google.idea.blaze.base.model.BlazeProjectData;
import com.google.idea.blaze.base.projectview.ProjectViewSet;
import com.google.idea.blaze.base.settings.BlazeImportSettings;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.project.Project;

/**
 * Extension interface for listening to syncs.
 */
public interface SyncListener {
  ExtensionPointName<SyncListener> EP_NAME = ExtensionPointName
    .create("com.google.idea.blaze.SyncListener");

  /**
   * Called after open documents have been saved, prior to starting the blaze sync.
   */
  void onSyncStart(Project project);

  /**
   * Called on successful completion of a sync
   */
  void onSyncComplete(
    Project project,
    BlazeImportSettings importSettings,
    ProjectViewSet projectViewSet,
    BlazeProjectData blazeProjectData);

  /**
   * Guaranteed to be called once per sync,
   * regardless of whether it successfully completed
   */
  void afterSync(Project project,
                 boolean successful);

  /**
   * Convenience adapter class.
   */
  abstract class Adapter implements SyncListener {

    @Override
    public void onSyncStart(Project project) {
    }

    @Override
    public void onSyncComplete(Project project,
                               BlazeImportSettings importSettings,
                               ProjectViewSet projectViewSet,
                               BlazeProjectData blazeProjectData) {
    }

    @Override
    public void afterSync(Project project, boolean successful) {
    }
  }
}