| /******************************************************************************* |
| * Copyright (c) 2007, 2008 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.statushandlers; |
| |
| import java.util.HashMap; |
| |
| import org.eclipse.core.runtime.IAdaptable; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.QualifiedName; |
| |
| /** |
| * <p> |
| * The StatusAdapter wraps an instance of IStatus subclass and can hold |
| * additional information either by using properties or by adding a new adapter. Used during |
| * status handling process. |
| * </p> |
| * |
| * @since 3.3 |
| */ |
| public class StatusAdapter implements IAdaptable { |
| |
| /** |
| * This property is used to add title to the adapter. If the adapter is |
| * shown in a dialog, this property is used to create title of the dialog. |
| * |
| * @deprecated use {@link IStatusAdapterConstants#TITLE_PROPERTY} instead |
| */ |
| public static final QualifiedName TITLE_PROPERTY = IStatusAdapterConstants.TITLE_PROPERTY; |
| |
| /** |
| * This property is used to add a timestamp to the adapter. If the adapter |
| * is shown in the UI, this property can be used for sorting and showing |
| * information about the status creation time. |
| * |
| * <p> |
| * The property must be of type <code>Long</code>. |
| * </p> |
| * |
| * @deprecated use {@link IStatusAdapterConstants#TIMESTAMP_PROPERTY} |
| * instead |
| */ |
| public static final QualifiedName TIMESTAMP_PROPERTY = IStatusAdapterConstants.TIMESTAMP_PROPERTY; |
| |
| private IStatus status; |
| |
| private HashMap properties; |
| |
| private HashMap adapters; |
| |
| /** |
| * Creates an instance of this class. |
| * |
| * @param status |
| * the status to wrap. May not be <code>null</code>. |
| */ |
| public StatusAdapter(IStatus status) { |
| this.status = status; |
| } |
| |
| /** |
| * Associates new object which is an instance of the given class with this |
| * adapter. object will be returned when {@link IAdaptable#getAdapter(Class)} |
| * is called on the receiver with {@link Class} adapter as a parameter. |
| * |
| * @param adapter |
| * the adapter class |
| * @param object |
| * the adapter instance |
| */ |
| public void addAdapter(Class adapter, Object object) { |
| if (adapters == null) { |
| adapters = new HashMap(); |
| } |
| adapters.put(adapter, object); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class) |
| */ |
| public Object getAdapter(Class adapter) { |
| if (adapters == null) { |
| return null; |
| } |
| return adapters.get(adapter); |
| } |
| |
| /** |
| * Returns the wrapped status. |
| * |
| * @return the wrapped status set in the constructor or in |
| * <code>setStatus(IStatus)</code>. Will not be <code>null</code>. |
| */ |
| public IStatus getStatus() { |
| return status; |
| } |
| |
| /** |
| * Sets a new status for this adapter. |
| * |
| * @param status |
| * the status to set. May not be <code>null</code>. |
| */ |
| public void setStatus(IStatus status) { |
| this.status = status; |
| } |
| |
| /** |
| * Returns the value of the adapter's property identified by the given key, |
| * or <code>null</code> if this adapter has no such property. |
| * |
| * @param key |
| * the qualified name of the property |
| * @return the value of the property, or <code>null</code> if this adapter |
| * has no such property |
| */ |
| public Object getProperty(QualifiedName key) { |
| if (properties == null) { |
| return null; |
| } |
| return properties.get(key); |
| } |
| |
| /** |
| * Sets the value of the receiver's property identified by the given key. |
| * |
| * @param key |
| * the qualified name of the property |
| * @param value |
| * the value of the property |
| */ |
| public void setProperty(QualifiedName key, Object value) { |
| if (properties == null) { |
| properties = new HashMap(); |
| } |
| properties.put(key, value); |
| } |
| } |