Top Description Constructors Methods
org.eclipse.swt.dnd

public abstract Class ByteArrayTransfer

extends Transfer
Class Inheritance
Known Direct Subclasses
org.eclipse.swt.dnd.FileTransfer, org.eclipse.swt.dnd.HTMLTransfer, org.eclipse.swt.dnd.ImageTransfer, org.eclipse.swt.dnd.RTFTransfer, org.eclipse.swt.dnd.TextTransfer, org.eclipse.swt.dnd.URLTransfer
Imports
org.eclipse.swt.internal.*, org.eclipse.swt.internal.gtk.*

The class ByteArrayTransfer provides a platform specific mechanism for converting a java byte[] to a platform specific representation of the byte array and vice versa.

ByteArrayTransfer is never used directly but is sub-classed by transfer agents that convert between data in a java format such as a String and a platform specific byte array.

If the data you are converting does not map to a byte[], you should sub-class Transfer directly and do your own mapping to a platform data type.

The following snippet shows a subclass of ByteArrayTransfer that transfers data defined by the class MyType.


 public class MyType {
	public String fileName;
	public long fileLength;
	public long lastModified;
 }
 

 public class MyTypeTransfer extends ByteArrayTransfer {

	private static final String MYTYPENAME = "my_type_name";
	private static final int MYTYPEID = registerType(MYTYPENAME);
	private static MyTypeTransfer _instance = new MyTypeTransfer();

 private MyTypeTransfer() {}

 public static MyTypeTransfer getInstance () {
 	return _instance;
 }
 public void javaToNative (Object object, TransferData transferData) {
 	if (object == null || !(object instanceof MyType[])) return;

 	if (isSupportedType(transferData)) {
 		MyType[] myTypes = (MyType[]) object;
 		try {
 			// write data to a byte array and then ask super to convert to pMedium
 			ByteArrayOutputStream out = new ByteArrayOutputStream();
 			DataOutputStream writeOut = new DataOutputStream(out);
 			for (int i = 0, length = myTypes.length; i < length;  i++){
 				byte[] buffer = myTypes[i].fileName.getBytes();
 				writeOut.writeInt(buffer.length);
 				writeOut.write(buffer);
 				writeOut.writeLong(myTypes[i].fileLength);
 				writeOut.writeLong(myTypes[i].lastModified);
 			}
 			byte[] buffer = out.toByteArray();
 			writeOut.close();

 			super.javaToNative(buffer, transferData);

 		} catch (IOException e) {
 		}
 	}
 }
 public Object nativeToJava(TransferData transferData){

 	if (isSupportedType(transferData)) {

 		byte[] buffer = (byte[])super.nativeToJava(transferData);
 		if (buffer == null) return null;

 		MyType[] myData = new MyType[0];
 		try {
 			ByteArrayInputStream in = new ByteArrayInputStream(buffer);
 			DataInputStream readIn = new DataInputStream(in);
 			while(readIn.available() > 20) {
 				MyType datum = new MyType();
 				int size = readIn.readInt();
 				byte[] name = new byte[size];
 				readIn.read(name);
 				datum.fileName = new String(name);
 				datum.fileLength = readIn.readLong();
 				datum.lastModified = readIn.readLong();
 				MyType[] newMyData = new MyType[myData.length + 1];
 				System.arraycopy(myData, 0, newMyData, 0, myData.length);
 				newMyData[myData.length] = datum;
 				myData = newMyData;
 			}
 			readIn.close();
 		} catch (IOException ex) {
 			return null;
 		}
 		return myData;
 	}

 	return null;
 }
 protected String[] getTypeNames(){
 	return new String[]{MYTYPENAME};
 }
 protected int[] getTypeIds(){
 	return new int[] {MYTYPEID};
 }
 }
 
See Also
Transfer

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
public TransferData[]
getSupportedTypes()

Implements abstract org.eclipse.swt.dnd.Transfer.getSupportedTypes.

Returns a list of the platform specific data types that can be converted using this transfer agent.
public boolean
isSupportedType(TransferData
a platform specific description of a data type; only the data type fields of the TransferData object need to be filled in
transferData
)

Implements abstract org.eclipse.swt.dnd.Transfer.isSupportedType.

Returns true if the TransferData data type can be converted using this transfer agent, or false otherwise (including if transferData is null).
protected void
javaToNative(Object
a java byte[] containing the data to be converted
object
,
TransferData
an empty TransferData object that will be filled in on return with the platform specific format of the data
transferData
)

Implements abstract org.eclipse.swt.dnd.Transfer.javaToNative.

This implementation of javaToNative converts a java byte[] to a platform specific representation.
protected Object

Returns:

a java byte[] containing the converted data if the conversion was successful; otherwise null
nativeToJava
(TransferData
the platform specific representation of the data to be converted
transferData
)

Implements abstract org.eclipse.swt.dnd.Transfer.nativeToJava.

This implementation of nativeToJava converts a platform specific representation of a byte array to a java byte[].
Inherited from org.eclipse.swt.dnd.Transfer:
getTypeIdsgetTypeNamesregisterTypevalidate

Constructor Detail

ByteArrayTransferback to summary
public ByteArrayTransfer()

Method Detail

checkByteArrayback to summary
pack-priv boolean checkByteArray(Object object)
getSupportedTypesback to summary
public TransferData[] getSupportedTypes()

Implements abstract org.eclipse.swt.dnd.Transfer.getSupportedTypes.

Doc from org.eclipse.swt.dnd.Transfer.getSupportedTypes.

Returns a list of the platform specific data types that can be converted using this transfer agent.

Only the data type fields of the TransferData objects are filled in.

Returns:TransferData[]

a list of the data types that can be converted using this transfer agent

Annotations
@Override
isSupportedTypeback to summary
public boolean isSupportedType(TransferData transferData)

Implements abstract org.eclipse.swt.dnd.Transfer.isSupportedType.

Doc from org.eclipse.swt.dnd.Transfer.isSupportedType.

Returns true if the TransferData data type can be converted using this transfer agent, or false otherwise (including if transferData is null).

Parameters
transferData:TransferData

a platform specific description of a data type; only the data type fields of the TransferData object need to be filled in

Returns:boolean

true if the transferData data type can be converted using this transfer agent

Annotations
@Override
javaToNativeback to summary
protected void javaToNative(Object object, TransferData transferData)

Implements abstract org.eclipse.swt.dnd.Transfer.javaToNative.

This implementation of javaToNative converts a java byte[] to a platform specific representation.

Parameters
object:Object

a java byte[] containing the data to be converted

transferData:TransferData

an empty TransferData object that will be filled in on return with the platform specific format of the data

Annotations
@Override
See Also
Transfer#nativeToJava
nativeToJavaback to summary
protected Object nativeToJava(TransferData transferData)

Implements abstract org.eclipse.swt.dnd.Transfer.nativeToJava.

This implementation of nativeToJava converts a platform specific representation of a byte array to a java byte[].

Parameters
transferData:TransferData

the platform specific representation of the data to be converted

Returns:Object

a java byte[] containing the converted data if the conversion was successful; otherwise null

Annotations
@Override
See Also
Transfer#javaToNative