IProgressOperation.java

/*
Copyright 2011-2016 Google Inc. 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.security.zynamics.binnavi.Gui.Progress;

import com.google.security.zynamics.zylib.gui.ProgressDialogs.CProgressPanel;

/**
 * Interface for ongoing progress operations.
 */
public interface IProgressOperation {
  /**
   * Returns the brief description of the progress operation.
   * 
   * @return The brief description string.
   */
  String getDescription();

  /**
   * Returns the progress panel that shows the progress made for that operation.
   * 
   * @return The progress panel for the operation.
   */
  CProgressPanel getProgressPanel();
}