bundles/org.eclipse.ui.ide/src/org/eclipse/ui/views/markers/internal/Util.java - platform/eclipse.platform.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2005 IBM Corporation and others.
  * 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:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/

 package org.eclipse.ui.views.markers.internal;

 import java.text.DateFormat;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Date;
 import java.util.Iterator;

 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.jface.resource.JFaceResources;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin;
 import org.eclipse.ui.views.markers.MarkerViewUtil;

 /**
  * The Util class is the class of general utilities used by the marker support.
  *
  */
 public final class Util {

 	static String EMPTY_STRING = "";//$NON-NLS-1$

 	static String TWO_LINE_FEED = "\n\n";//$NON-NLS-1$

 	static String LINE_FEED_AND_TAB = "\n\t";//$NON-NLS-1$

 	private static final String IMAGE_ERROR_PATH = "obj16/error_tsk.gif"; //$NON-NLS-1$

 	private static final String IMAGE_WARNING_PATH = "obj16/warn_tsk.gif"; //$NON-NLS-1$

 	private static final String IMAGE_INFO_PATH = "obj16/info_tsk.gif"; //$NON-NLS-1$

 	static final MarkerNode[] EMPTY_MARKER_ARRAY = new MarkerNode[0];

 	static final ConcreteMarker[] EMPTY_CONCRETE_MARKER_ARRAY = new ConcreteMarker[0];

 	protected static final Collection EMPTY_COLLECTION = Arrays.asList(new MarkerNode[0]);

 	/**
 	 * Get the propery called property from the marker. If it is not found
 	 * return the empty string.
 	 *
 	 * @param property
 	 * @param marker
 	 * @return String
 	 */
 	public static String getProperty(String property, IMarker marker) {
 		if (marker == null)
 			return EMPTY_STRING;
 		try {
 			Object obj = marker.getAttribute(property);
 			if (obj != null)
 				return obj.toString();
 			return EMPTY_STRING;
 		} catch (CoreException e) {
 			log(e);
 			return EMPTY_STRING;
 		}
 	}

 	/**
 	 * Get the human readable creation time from the timestamp
 	 *
 	 * @param timestamp
 	 * @return String
 	 */
 	public static String getCreationTime(long timestamp) {
 		return DateFormat.getDateTimeInstance(DateFormat.LONG,
 				DateFormat.MEDIUM).format(new Date(timestamp));
 	}

 	/**
 	 * Get the human readable creation time from the marker.
 	 *
 	 * @param marker
 	 * @return String
 	 */
 	public static String getCreationTime(IMarker marker) {
 		try {
 			return getCreationTime(marker.getCreationTime());
 		} catch (CoreException e) {
 			log(e);
 			return EMPTY_STRING;
 		}
 	}

 	/**
 	 * Get the name of the container. If the marker has the
 	 * MarkerViewUtil#PATH_ATTRIBUTE set use that. Otherwise use the path of the
 	 * parent resource.
 	 *
 	 * @param marker
 	 * @return String
 	 */
 	public static String getContainerName(IMarker marker) {

 		try {
 			Object pathAttribute = marker
 					.getAttribute(MarkerViewUtil.PATH_ATTRIBUTE);

 			if (pathAttribute != null)
 				return pathAttribute.toString();
 		} catch (CoreException exception) {
 			// Log the exception and fall back.
 			log(exception);
 		}

 		IPath path = marker.getResource().getFullPath();
 		int n = path.segmentCount() - 1; // n is the number of segments in
 		// container, not path
 		if (n <= 0)
 			return Util.EMPTY_STRING;
 		int len = 0;
 		for (int i = 0; i < n; ++i)
 			len += path.segment(i).length();
 		// account for /'s
 		if (n > 1)
 			len += n - 1;
 		StringBuffer sb = new StringBuffer(len);
 		for (int i = 0; i < n; ++i) {
 			if (i != 0)
 				sb.append('/');
 			sb.append(path.segment(i));
 		}
 		return sb.toString();
 	}

 	/**
 	 * Log the exception.
 	 *
 	 * @param exception
 	 */
 	public static void log(CoreException exception) {
 		IDEWorkbenchPlugin.getDefault().getLog().log(exception.getStatus());
 	}

 	/**
 	 * Get the name of the element. If the marker has the
 	 * MarkerViewUtil#NAME_ATTRIBUTE set use that. Otherwise use the name of the
 	 * resource.
 	 *
 	 * @param marker
 	 * @return String
 	 */
 	public static String getResourceName(IMarker marker) {

 		try {
 			Object nameAttribute = marker
 					.getAttribute(MarkerViewUtil.NAME_ATTRIBUTE);

 			if (nameAttribute != null)
 				return nameAttribute.toString();
 		} catch (CoreException exception) {
 			log(exception);
 		}

 		return marker.getResource().getName();
 	}

 	/**
 	 * Return whether or not the marker is editable.
 	 *
 	 * @param marker
 	 * @return boolean <code>true</code> if it is editable
 	 */
 	public static boolean isEditable(IMarker marker) {
 		if (marker == null) {
 			return false;
 		}
 		try {
 			return marker.isSubtypeOf(IMarker.BOOKMARK)
 					|| (marker.isSubtypeOf(IMarker.TASK) && marker
 							.getAttribute(IMarker.USER_EDITABLE, true));
 		} catch (CoreException e) {
 			return false;
 		}
 	}

 	/**
 	 * Return an error status for the given exception.
 	 *
 	 * @param exception
 	 * @return IStatus
 	 */
 	public static IStatus errorStatus(Throwable exception) {
 		String message = exception.getLocalizedMessage();
 		if(message == null)
 			message = EMPTY_STRING;
 		return new Status(IStatus.ERROR, IDEWorkbenchPlugin.IDE_WORKBENCH,
 				IStatus.ERROR,message , exception);
 	}

 	private Util() {
 		super();
 	}

 	/**
 	 * Get the image for the severity if it can be identified.
 	 *
 	 * @param severity
 	 * @return Image or <code>null</code>
 	 */
 	public static Image getImage(int severity) {

 		if (severity == IMarker.SEVERITY_ERROR) {
 			return getIDEImage(IMAGE_ERROR_PATH);
 		}
 		if (severity == IMarker.SEVERITY_WARNING) {
 			return getIDEImage(IMAGE_WARNING_PATH);
 		}
 		if (severity == IMarker.SEVERITY_INFO) {
 			return getIDEImage(IMAGE_INFO_PATH);
 		}

 		return null;
 	}

 	/**
 	 * Get the IDE image at path.
 	 *
 	 * @param path
 	 * @return Image
 	 */
 	private static Image getIDEImage(String path) {
 		return JFaceResources.getResources().createImageWithDefault(
 				IDEWorkbenchPlugin.getIDEImageDescriptor(path));

 	}

 	/**
 	 * Return the text for severity
 	 * @param severity
 	 * @return String
 	 */
 	public static String getSeverityText(int severity) {
 		if (severity == IMarker.SEVERITY_ERROR) {
 			return MarkerMessages.propertiesDialog_errorLabel;
 		}
 		if (severity == IMarker.SEVERITY_WARNING) {
 			return MarkerMessages.propertiesDialog_warningLabel;
 		}
 		if (severity == IMarker.SEVERITY_INFO) {
 			return MarkerMessages.propertiesDialog_infoLabel;
 		}

 		return EMPTY_STRING;

 	}

 	/**
 	 * Get the short name for the container
 	 * @param marker
 	 * @return String
 	 */
 	public static String getShortContainerName(IMarker marker) {

 		try {
 			Object pathAttribute = marker
 					.getAttribute(MarkerViewUtil.PATH_ATTRIBUTE);

 			if (pathAttribute != null)
 				return pathAttribute.toString();
 		} catch (CoreException exception) {
 			// Log the exception and fall back.
 			log(exception);
 		}

 		IResource resource = marker.getResource();
 		int type = resource.getType();

 		//Cannot be project relative if it is the root or a project
 		if(type == IResource.PROJECT)
 			return resource.getName();

 		if(type == IResource.ROOT)
 			return MarkerMessages.Util_WorkspaceRoot;

 		String result =  marker.getResource().getProjectRelativePath().removeLastSegments(1).toOSString();
 		if(result.trim().length() == 0)
 			return MarkerMessages.Util_ProjectRoot;
 		return result;
 	}

 	/**
 	 * Return whether or not the selection has one element that
 	 * is concrete.
 	 * @param selection
 	 * @return <true>code</true> if the selection has one element that
 	 * is concrete.
 	 */
 	static boolean isSingleConcreteSelection(IStructuredSelection selection) {
 		if( selection != null && selection.size() == 1){
 			Object first = selection.getFirstElement();
 			if(first instanceof MarkerNode)
 			 return((MarkerNode) first).isConcrete();
 		}
 		return false;
 	}

 	/**
 	 * Return whether or not all of the elements in the selection
 	 * are concrete.
 	 * @param selection
 	 * @return <true>code</true> if all of the elements are concrete.
 	 */
 	public static boolean allConcreteSelection(IStructuredSelection selection) {
 		if( selection != null && selection.size()>0){
 			Iterator nodes = selection.iterator();
 			while(nodes.hasNext()){
 				if(((MarkerNode) nodes.next()).isConcrete())
 					continue;
 				return false;
 			}
 			return true;
 		}
 		return false;
 	}

 	/**
 	 * Return the name of the marker type if it can be determined.
 	 * @param marker
 	 * @param model
 	 * @return String or <code>null</code>
 	 */
 	public static String getMarkerTypeName(ConcreteMarker marker) {
 		try {
 			String typeId =  marker.getMarker().getType();
 			MarkerType type = MarkerTypesModel.getInstance().getType(typeId);
 			return type.getLabel();
 		} catch (CoreException e) {
 			IDEWorkbenchPlugin.log(e.getLocalizedMessage(), e.getStatus());
 			return null;
 		}
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2005 IBM Corporation and others.
	* 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:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/

	package org.eclipse.ui.views.markers.internal;

	import java.text.DateFormat;
	import java.util.Arrays;
	import java.util.Collection;
	import java.util.Date;
	import java.util.Iterator;

	import org.eclipse.core.resources.IMarker;
	import org.eclipse.core.resources.IResource;
	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IPath;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.jface.resource.JFaceResources;
	import org.eclipse.jface.viewers.IStructuredSelection;
	import org.eclipse.swt.graphics.Image;
	import org.eclipse.ui.internal.ide.IDEWorkbenchPlugin;
	import org.eclipse.ui.views.markers.MarkerViewUtil;

	/**
	* The Util class is the class of general utilities used by the marker support.
	*
	*/
	public final class Util {

	static String EMPTY_STRING = "";//$NON-NLS-1$

	static String TWO_LINE_FEED = "\n\n";//$NON-NLS-1$

	static String LINE_FEED_AND_TAB = "\n\t";//$NON-NLS-1$

	private static final String IMAGE_ERROR_PATH = "obj16/error_tsk.gif"; //$NON-NLS-1$

	private static final String IMAGE_WARNING_PATH = "obj16/warn_tsk.gif"; //$NON-NLS-1$

	private static final String IMAGE_INFO_PATH = "obj16/info_tsk.gif"; //$NON-NLS-1$

	static final MarkerNode[] EMPTY_MARKER_ARRAY = new MarkerNode[0];

	static final ConcreteMarker[] EMPTY_CONCRETE_MARKER_ARRAY = new ConcreteMarker[0];

	protected static final Collection EMPTY_COLLECTION = Arrays.asList(new MarkerNode[0]);

	/**
	* Get the propery called property from the marker. If it is not found
	* return the empty string.
	*
	* @param property
	* @param marker
	* @return String
	*/
	public static String getProperty(String property, IMarker marker) {
	if (marker == null)
	return EMPTY_STRING;
	try {
	Object obj = marker.getAttribute(property);
	if (obj != null)
	return obj.toString();
	return EMPTY_STRING;
	} catch (CoreException e) {
	log(e);
	return EMPTY_STRING;
	}
	}

	/**
	* Get the human readable creation time from the timestamp
	*
	* @param timestamp
	* @return String
	*/
	public static String getCreationTime(long timestamp) {
	return DateFormat.getDateTimeInstance(DateFormat.LONG,
	DateFormat.MEDIUM).format(new Date(timestamp));
	}

	/**
	* Get the human readable creation time from the marker.
	*
	* @param marker
	* @return String
	*/
	public static String getCreationTime(IMarker marker) {
	try {
	return getCreationTime(marker.getCreationTime());
	} catch (CoreException e) {
	log(e);
	return EMPTY_STRING;
	}
	}

	/**
	* Get the name of the container. If the marker has the
	* MarkerViewUtil#PATH_ATTRIBUTE set use that. Otherwise use the path of the
	* parent resource.
	*
	* @param marker
	* @return String
	*/
	public static String getContainerName(IMarker marker) {

	try {
	Object pathAttribute = marker
	.getAttribute(MarkerViewUtil.PATH_ATTRIBUTE);

	if (pathAttribute != null)
	return pathAttribute.toString();
	} catch (CoreException exception) {
	// Log the exception and fall back.
	log(exception);
	}

	IPath path = marker.getResource().getFullPath();
	int n = path.segmentCount() - 1; // n is the number of segments in
	// container, not path
	if (n <= 0)
	return Util.EMPTY_STRING;
	int len = 0;
	for (int i = 0; i < n; ++i)
	len += path.segment(i).length();
	// account for /'s
	if (n > 1)
	len += n - 1;
	StringBuffer sb = new StringBuffer(len);
	for (int i = 0; i < n; ++i) {
	if (i != 0)
	sb.append('/');
	sb.append(path.segment(i));
	}
	return sb.toString();
	}

	/**
	* Log the exception.
	*
	* @param exception
	*/
	public static void log(CoreException exception) {
	IDEWorkbenchPlugin.getDefault().getLog().log(exception.getStatus());
	}

	/**
	* Get the name of the element. If the marker has the
	* MarkerViewUtil#NAME_ATTRIBUTE set use that. Otherwise use the name of the
	* resource.
	*
	* @param marker
	* @return String
	*/
	public static String getResourceName(IMarker marker) {

	try {
	Object nameAttribute = marker
	.getAttribute(MarkerViewUtil.NAME_ATTRIBUTE);

	if (nameAttribute != null)
	return nameAttribute.toString();
	} catch (CoreException exception) {
	log(exception);
	}

	return marker.getResource().getName();
	}

	/**
	* Return whether or not the marker is editable.
	*
	* @param marker
	* @return boolean <code>true</code> if it is editable
	*/
	public static boolean isEditable(IMarker marker) {
	if (marker == null) {
	return false;
	}
	try {
	return marker.isSubtypeOf(IMarker.BOOKMARK)
	\|\| (marker.isSubtypeOf(IMarker.TASK) && marker
	.getAttribute(IMarker.USER_EDITABLE, true));
	} catch (CoreException e) {
	return false;
	}
	}

	/**
	* Return an error status for the given exception.
	*
	* @param exception
	* @return IStatus
	*/
	public static IStatus errorStatus(Throwable exception) {
	String message = exception.getLocalizedMessage();
	if(message == null)
	message = EMPTY_STRING;
	return new Status(IStatus.ERROR, IDEWorkbenchPlugin.IDE_WORKBENCH,
	IStatus.ERROR,message , exception);
	}

	private Util() {
	super();
	}

	/**
	* Get the image for the severity if it can be identified.
	*
	* @param severity
	* @return Image or <code>null</code>
	*/
	public static Image getImage(int severity) {

	if (severity == IMarker.SEVERITY_ERROR) {
	return getIDEImage(IMAGE_ERROR_PATH);
	}
	if (severity == IMarker.SEVERITY_WARNING) {
	return getIDEImage(IMAGE_WARNING_PATH);
	}
	if (severity == IMarker.SEVERITY_INFO) {
	return getIDEImage(IMAGE_INFO_PATH);
	}

	return null;
	}

	/**
	* Get the IDE image at path.
	*
	* @param path
	* @return Image
	*/
	private static Image getIDEImage(String path) {
	return JFaceResources.getResources().createImageWithDefault(
	IDEWorkbenchPlugin.getIDEImageDescriptor(path));

	}

	/**
	* Return the text for severity
	* @param severity
	* @return String
	*/
	public static String getSeverityText(int severity) {
	if (severity == IMarker.SEVERITY_ERROR) {
	return MarkerMessages.propertiesDialog_errorLabel;
	}
	if (severity == IMarker.SEVERITY_WARNING) {
	return MarkerMessages.propertiesDialog_warningLabel;
	}
	if (severity == IMarker.SEVERITY_INFO) {
	return MarkerMessages.propertiesDialog_infoLabel;
	}

	return EMPTY_STRING;

	}

	/**
	* Get the short name for the container
	* @param marker
	* @return String
	*/
	public static String getShortContainerName(IMarker marker) {

	try {
	Object pathAttribute = marker
	.getAttribute(MarkerViewUtil.PATH_ATTRIBUTE);

	if (pathAttribute != null)
	return pathAttribute.toString();
	} catch (CoreException exception) {
	// Log the exception and fall back.
	log(exception);
	}

	IResource resource = marker.getResource();
	int type = resource.getType();

	//Cannot be project relative if it is the root or a project
	if(type == IResource.PROJECT)
	return resource.getName();

	if(type == IResource.ROOT)
	return MarkerMessages.Util_WorkspaceRoot;

	String result = marker.getResource().getProjectRelativePath().removeLastSegments(1).toOSString();
	if(result.trim().length() == 0)
	return MarkerMessages.Util_ProjectRoot;
	return result;
	}

	/**
	* Return whether or not the selection has one element that
	* is concrete.
	* @param selection
	* @return <true>code</true> if the selection has one element that
	* is concrete.
	*/
	static boolean isSingleConcreteSelection(IStructuredSelection selection) {
	if( selection != null && selection.size() == 1){
	Object first = selection.getFirstElement();
	if(first instanceof MarkerNode)
	return((MarkerNode) first).isConcrete();
	}
	return false;
	}

	/**
	* Return whether or not all of the elements in the selection
	* are concrete.
	* @param selection
	* @return <true>code</true> if all of the elements are concrete.
	*/
	public static boolean allConcreteSelection(IStructuredSelection selection) {
	if( selection != null && selection.size()>0){
	Iterator nodes = selection.iterator();
	while(nodes.hasNext()){
	if(((MarkerNode) nodes.next()).isConcrete())
	continue;
	return false;
	}
	return true;
	}
	return false;
	}

	/**
	* Return the name of the marker type if it can be determined.
	* @param marker
	* @param model
	* @return String or <code>null</code>
	*/
	public static String getMarkerTypeName(ConcreteMarker marker) {
	try {
	String typeId = marker.getMarker().getType();
	MarkerType type = MarkerTypesModel.getInstance().getType(typeId);
	return type.getLabel();
	} catch (CoreException e) {
	IDEWorkbenchPlugin.log(e.getLocalizedMessage(), e.getStatus());
	return null;
	}
	}
	}