blob: caa3bf2a4032c11cb7756cb1a44719cd12bd6d66 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2003 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;
/**
* The class <code>FileTransfer</code> provides a platform specific mechanism
* for converting a list of files represented as a java <code>String[]</code> to a
* platform specific representation of the data and vice versa.
* Each <code>String</code> in the array contains the absolute path for a single
* file or directory.
* See <code>Transfer</code> for additional information.
*
* <p>An example of a java <code>String[]</code> containing a list of files is shown
* below:</p>
*
* <code><pre>
* File file1 = new File("C:\temp\file1");
* File file2 = new File("C:\temp\file2");
* String[] fileData = new String[2];
* fileData[0] = file1.getAbsolutePath();
* fileData[1] = file2.getAbsolutePath();
* </code></pre>
*/
public class FileTransfer extends ByteArrayTransfer {
private FileTransfer() {}
/**
* Returns the singleton instance of the FileTransfer class.
*
* @return the singleton instance of the FileTransfer class
*/
public static FileTransfer getInstance () {
return null;
}
/**
* This implementation of <code>javaToNative</code> converts a list of file names
* represented by a java <code>String[]</code> to a platform specific representation.
* Each <code>String</code> in the array contains the absolute path for a single
* file or directory. For additional information see
* <code>Transfer#javaToNative</code>.
*
* @param object a java <code>String[]</code> containing the file names to be
* converted
* @param transferData an empty <code>TransferData</code> object; this
* object will be filled in on return with the platform specific format of the data
*/
public void javaToNative(Object object, TransferData transferData) {
}
/**
* This implementation of <code>nativeToJava</code> converts a platform specific
* representation of a list of file names to a java <code>String[]</code>.
* Each String in the array contains the absolute path for a single file or directory.
* For additional information see <code>Transfer#nativeToJava</code>.
*
* @param transferData the platform specific representation of the data to be
* been converted
* @return a java <code>String[]</code> containing a list of file names if the
* conversion was successful; otherwise null
*/
public Object nativeToJava(TransferData transferData) {
return null;
}
protected String[] getTypeNames(){
return null;
}
protected int[] getTypeIds(){
return null;
}
}