IDifferenceCategoryItem.java

/**
 * <copyright>
 * 
 * Copyright (c) 2016 Thales Global Services S.A.S.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Thales Global Services S.A.S. - initial API and implementation
 * 
 * </copyright>
 */
package org.eclipse.emf.diffmerge.ui.viewers;

import org.eclipse.swt.graphics.Image;


/**
 * An item related to difference categories for UI purposes.
 * Difference category items are structurally organized as a forest.
 * @author Olivier Constant
 */
public interface IDifferenceCategoryItem {
  
  /**
   * Return a user-friendly description for this category item in the context of the given
   * diff node
   * @return a potentially null string
   */
  String getDescription(EMFDiffNode node_p);
  
  /**
   * Return an optional image for this category item in the context of the given diff node.
   * The image must not be owned by the category.
   * @param node_p a non-null diff node
   * @return a potentially null image
   */
  Image getImage(EMFDiffNode node_p);
  
  /**
   * Return the parent of this item, if any
   * @return a potentially null category set
   */
  IDifferenceCategorySet getParent();
  
  /**
   * Return a user-friendly name for this category item in the context of the given diff node
   * @param node_p a non-null diff node
   * @return a non-null string
   */
  String getText(EMFDiffNode node_p);
  
}