android/src/com/android/tools/idea/gradle/service/sync/change/ProjectStructureChange.java

/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * 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.android.tools.idea.gradle.service.sync.change;

import com.intellij.openapi.externalSystem.model.Key;
import org.jetbrains.annotations.NotNull;

/**
 * Object-level representation of ide project structure change.
 *
 * @param <T>  type of the target project structure entity targeted by the current change
 */
public interface ProjectStructureChange<T> {

  /**
   * @return    specification for the project structure entity type targeted by the current change
   */
  @NotNull
  Key<T> getKey();

  /**
   * @return    human-readable description of the current change object
   */
  @NotNull
  String getDescription();

  void accept(@NotNull ProjectStructureChangeVisitor visitor);
}