org.eclipse.swt.dnd.TransferData Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 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.swt.dnd;
import org.eclipse.swt.internal.SerializableCompatibility;
/**
* The TransferData class is a platform specific data structure for
* describing the type and the contents of data being converted by a transfer agent.
*
* As an application writer, you do not need to know the specifics of
* TransferData. TransferData instances are passed to a subclass of Transfer
* and the Transfer object manages the platform specific issues.
* You can ask a Transfer subclass if it can handle this data by calling
* Transfer.isSupportedType(transferData).
*
* You should only need to become familiar with the fields in this class if you
* are implementing a Transfer subclass and you are unable to subclass the
* ByteArrayTransfer class.
*
* @since 1.3
*/
public class TransferData implements SerializableCompatibility {
/**
* The type is a unique identifier of a system format or user defined format.
* (Warning: This field is platform dependent)
*
* IMPORTANT: This field is not part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
*
*/
public int type;
/**
* IMPORTANT: This field is not part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
*/
public Object data;
/**
* The result field contains the result of converting a
* java data type into a platform specific value.
* (Warning: This field is platform dependent)
*
* IMPORTANT: This field is not part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
*
* The value of result is 1 if the conversion was successful.
* The value of result is 0 if the conversion failed.
*/
public int result;
public static boolean sameType(TransferData data1, TransferData data2) {
if (data1 == data2) return true;
if (data1 == null || data2 == null) return false;
return data1.type == data2.type;
}
}