mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-15 13:05:22 +02:00
Code Issues Wiki Activity

[releng][cleanup] Fix @since tags according to API Tooling

Browse source
This commit is contained in:
Martin Oberhuber 2008-06-04 10:32:44 +00:00
parent 5bdffc6d25
commit b15c28c5fc
8 changed files with 735 additions and 576 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemSelectRemoteFileAction.java
View file

@ -456,6 +456,9 @@ public class SystemSelectRemoteFileAction extends SystemBaseDialogAction
return outputConnection; return outputConnection;
} }
/**
* @since 3.0
*/
public void setCustomViewerFilter(SystemActionViewerFilter filter) public void setCustomViewerFilter(SystemActionViewerFilter filter)
{ {
customViewerFilter = filter; customViewerFilter = filter;

3
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemSelectRemoteFolderAction.java
View file

@ -399,6 +399,9 @@ public class SystemSelectRemoteFolderAction extends SystemBaseDialogAction
return outputConnection; return outputConnection;
} }
/**
* @since 3.0
*/
public void setCustomViewerFilter(SystemActionViewerFilter filter) public void setCustomViewerFilter(SystemActionViewerFilter filter)
{ {
customViewerFilter = filter; customViewerFilter = filter;

4
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java
View file

@ -212,6 +212,8 @@ public class SystemEditableRemoteFile implements ISystemEditableRemoteObject, IP
/** /**
* Constructor for SystemEditableRemoteFile * Constructor for SystemEditableRemoteFile
*
* @since 3.0 changed String editorId into IEditorDescriptor
*/ */
public SystemEditableRemoteFile(IWorkbenchPage page, IRemoteFile remoteFile, IEditorDescriptor editorDescriptor) public SystemEditableRemoteFile(IWorkbenchPage page, IRemoteFile remoteFile, IEditorDescriptor editorDescriptor)
{ {
@ -233,6 +235,8 @@ public class SystemEditableRemoteFile implements ISystemEditableRemoteObject, IP
/** /**
* Constructor for SystemEditableRemoteFile * Constructor for SystemEditableRemoteFile
*
* @since 3.0 changed String editorId into IEditorDescriptor
*/ */
public SystemEditableRemoteFile(IRemoteFile remoteFile, IEditorDescriptor editorDescriptor) public SystemEditableRemoteFile(IRemoteFile remoteFile, IEditorDescriptor editorDescriptor)
{ {

6
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/UniversalFileTransferUtility.java
View file

@ -1150,9 +1150,11 @@ public class UniversalFileTransferUtility
/** /**
* Replicates a remote file or folder to the workspace * Replicates a remote file or folder to the workspace
*
* @param srcFileOrFolder the object which is being copied * @param srcFileOrFolder the object which is being copied
* @param monitor a progress monitor * @param monitor a progress monitor
* @return the temporary object that was created after the download * @return the temporary object that was created after the download
* @since 3.0
*/ */
public static Object downloadResourceToWorkspace(IRemoteFile srcFileOrFolder, IProgressMonitor monitor) public static Object downloadResourceToWorkspace(IRemoteFile srcFileOrFolder, IProgressMonitor monitor)
{ {
@ -2726,6 +2728,10 @@ public class UniversalFileTransferUtility
_targetFileOrFolder = targetFileOrFolder; _targetFileOrFolder = targetFileOrFolder;
cancelStatus = RENAME_DIALOG_NOT_CANCELLED; cancelStatus = RENAME_DIALOG_NOT_CANCELLED;
} }
/**
* @since 3.0
*/
public RenameRunnable(IRemoteFile targetFileOrFolder, List namesInUse) public RenameRunnable(IRemoteFile targetFileOrFolder, List namesInUse)
{ {
_targetFileOrFolder = targetFileOrFolder; _targetFileOrFolder = targetFileOrFolder;

8
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/widgets/SystemSelectRemoteFileOrFolderForm.java
View file

@ -198,6 +198,9 @@ public class SystemSelectRemoteFileOrFolderForm
/** /**
* Returns the input provider that drives the contents of the tree * Returns the input provider that drives the contents of the tree
* Subclasses can override to provide custom tree contents * Subclasses can override to provide custom tree contents
*
* @since 3.0 replaced SystemSelectRemoteObjectAPIProvider by
* ISystemSelectRemoteObjectAPIProvider
*/ */
protected ISystemSelectRemoteObjectAPIProvider getInputProvider() protected ISystemSelectRemoteObjectAPIProvider getInputProvider()
{ {
@ -1057,13 +1060,18 @@ public class SystemSelectRemoteFileOrFolderForm
/** /**
* Returns the system tree * Returns the system tree
*
* @return the system tree * @return the system tree
* @since 3.0 replacing the previous getSystemViewForm method
*/ */
public ISystemTree getSystemTree() public ISystemTree getSystemTree()
{ {
return tree.getSystemTree(); return tree.getSystemTree();
} }
/**
* @since 3.0
*/
public Object getSelectedParent() public Object getSelectedParent()
{ {
return tree.getSelectedParent(); return tree.getSelectedParent();

230
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/archiveutils/SystemTarHandler.java
View file

@ -73,6 +73,7 @@ public class SystemTarHandler implements ISystemArchiveHandler {
protected File file; protected File file;
protected long modTimeDuringCache; protected long modTimeDuringCache;
protected VirtualFileSystem vfs; protected VirtualFileSystem vfs;
/** @since 3.0 */
protected SystemReentrantMutex _mutex; protected SystemReentrantMutex _mutex;
/** /**
@ -607,9 +608,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* Update the virtual file system tree. * Update the virtual file system tree. If newOldName HashMap is input, use
* If newOldName HashMap is input, use the old name in the HashMap * the old name in the HashMap to do the search in virtual file system tree.
* to do the search in virtual file system tree. *
* @since 3.0
*/ */
protected void updateTree(HashMap newOldNames) protected void updateTree(HashMap newOldNames)
{ {
@ -648,7 +650,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
/** /**
* Gets a tar file from the underlying file. * Gets a tar file from the underlying file.
* @return the tar file, or <code>null</code> if the tar file does not exist. *
* @return the tar file, or <code>null</code> if the tar file does not
* exist.
* @since 3.0 TarFile moved to API
*/ */
protected TarFile getTarFile() { protected TarFile getTarFile() {
@ -684,9 +689,9 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildrenList(org.eclipse.rse.services.clientserver.ISystemOperationMonitor) * @since 3.0
*/ */
public VirtualChild[] getVirtualChildrenList(ISystemOperationMonitor archiveOperationMonitor) { public VirtualChild[] getVirtualChildrenList(ISystemOperationMonitor archiveOperationMonitor) {
@ -714,9 +719,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return children; return children;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildrenList(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildrenList(String parent, ISystemOperationMonitor archiveOperationMonitor) { public VirtualChild[] getVirtualChildrenList(String parent, ISystemOperationMonitor archiveOperationMonitor) {
parent = ArchiveHandlerManager.cleanUpVirtualPath(parent); parent = ArchiveHandlerManager.cleanUpVirtualPath(parent);
@ -753,9 +759,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return children; return children;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildren(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildren(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) { public VirtualChild[] getVirtualChildren(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) {
@ -771,9 +778,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return vfs.getChildren(fullVirtualName); return vfs.getChildren(fullVirtualName);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildFolders(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildFolders(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) { public VirtualChild[] getVirtualChildFolders(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) {
@ -789,9 +797,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return vfs.getChildrenFolders(fullVirtualName); return vfs.getChildrenFolders(fullVirtualName);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualFile(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public VirtualChild getVirtualFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) { public VirtualChild getVirtualFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) {
@ -820,9 +829,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return entry; return entry;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#exists(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public boolean exists(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) { public boolean exists(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) {
@ -899,8 +909,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualFile(java.lang.String, java.io.File) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualFile(String fullVirtualName, File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void extractVirtualFile(String fullVirtualName, File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName); fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName);
@ -991,16 +1003,19 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, ISystemOperationMonitor) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String fullVirtualName, File destinationParent, ISystemOperationMonitor archiveOperationMonitor) public void extractVirtualDirectory(String fullVirtualName, File destinationParent, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException { throws SystemMessageException {
extractVirtualDirectory(fullVirtualName, destinationParent, (File) null, archiveOperationMonitor); extractVirtualDirectory(fullVirtualName, destinationParent, (File) null, archiveOperationMonitor);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.io.File, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void extractVirtualDirectory(String fullVirtualName, File destinationParent, File destination, ISystemOperationMonitor archiveOperationMonitor) public void extractVirtualDirectory(String fullVirtualName, File destinationParent, File destination, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException { throws SystemMessageException {
@ -1100,9 +1115,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File, java.lang.String, java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(File file, String virtualPath, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void add(File file, String virtualPath, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
virtualPath = ArchiveHandlerManager.cleanUpVirtualPath(virtualPath); virtualPath = ArchiveHandlerManager.cleanUpVirtualPath(virtualPath);
@ -1179,6 +1195,8 @@ public class SystemTarHandler implements ISystemArchiveHandler {
* Helper method. Populates given List <code>found</code> with a collapsed * Helper method. Populates given List <code>found</code> with a collapsed
* list of all nodes in the subtree of the file system rooted at * list of all nodes in the subtree of the file system rooted at
* <code>parent</code>. * <code>parent</code>.
*
* @since 3.0 Vector changed into List
*/ */
public void listAllFiles(File parent, List found) { public void listAllFiles(File parent, List found) {
@ -1194,9 +1212,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File[], java.lang.String, java.lang.String[], org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(File[] files, String virtualPath, String[] names, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void add(File[] files, String virtualPath, String[] names, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
@ -1406,11 +1425,14 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* Appends a file to a tar output stream, using the given entry that represents the file. * Appends a file to a tar output stream, using the given entry that
* represents the file.
*
* @param file the file to be appended to the tar output stream. * @param file the file to be appended to the tar output stream.
* @param entry the entry which represents the file. * @param entry the entry which represents the file.
* @param outStream the tar output stream. * @param outStream the tar output stream.
* @throws IOException if an I/O error occurs. * @throws IOException if an I/O error occurs.
* @since 3.0 TarEntry moved into API
*/ */
protected void appendFile(File file, TarEntry entry, TarOutputStream outStream) throws IOException { protected void appendFile(File file, TarEntry entry, TarOutputStream outStream) throws IOException {
@ -1442,9 +1464,11 @@ public class SystemTarHandler implements ISystemArchiveHandler {
* Creates a tar entry for a file with the given virtual path. The entry * Creates a tar entry for a file with the given virtual path. The entry
* will contain the size and last modified time of the file. The entry's * will contain the size and last modified time of the file. The entry's
* checksum will be calculated. * checksum will be calculated.
*
* @param file the file for which to create a tar entry. * @param file the file for which to create a tar entry.
* @param virtualPath the virtual path for the entry. * @param virtualPath the virtual path for the entry.
* @return the tar entry representing the given file. * @return the tar entry representing the given file.
* @since 3.0 TarEntry moved into API
*/ */
protected TarEntry createTarEntry(File file, String virtualPath) { protected TarEntry createTarEntry(File file, String virtualPath) {
@ -1528,13 +1552,16 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* Changes a tar entry according to the file information and given path. The given path * Changes a tar entry according to the file information and given path. The
* will be the new name of the entry. The size and last modified fields will be changed * given path will be the new name of the entry. The size and last modified
* to the file's size and last modified time. The entry's checksum will be calculated. * fields will be changed to the file's size and last modified time. The
* entry's checksum will be calculated.
*
* @param entry the entry that needs to be changed. * @param entry the entry that needs to be changed.
* @param file the file for which the tar entry is being changed. * @param file the file for which the tar entry is being changed.
* @param virtualPath the virtual path for the entry. * @param virtualPath the virtual path for the entry.
* @return the changed entry. * @return the changed entry.
* @since 3.0 TarEntry moved into API
*/ */
protected TarEntry changeTarEntry(TarEntry entry, File file, String virtualPath) { protected TarEntry changeTarEntry(TarEntry entry, File file, String virtualPath) {
@ -1582,8 +1609,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
/** /**
* Returns a virtual child given a tar entry. * Returns a virtual child given a tar entry.
*
* @param entry a tar entry. * @param entry a tar entry.
* @return the virtual child that represents the tar entry. * @return the virtual child that represents the tar entry.
* @since 3.0 TarEntry moved into API
*/ */
protected VirtualChild getVirtualChild(TarEntry entry) { protected VirtualChild getVirtualChild(TarEntry entry) {
VirtualChild child = new VirtualChild(this, entry.getName()); VirtualChild child = new VirtualChild(this, entry.getName());
@ -1598,8 +1627,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
/** /**
* update a virtual child given a tar entry. * update a virtual child given a tar entry.
*
* @param entry a tar entry. * @param entry a tar entry.
* @return the virtual child that represents the tar entry. * @return the virtual child that represents the tar entry.
* @since 3.0 TarEntry moved into API
*/ */
protected VirtualChild updateVirtualChild(TarEntry entry, VirtualChild child) { protected VirtualChild updateVirtualChild(TarEntry entry, VirtualChild child) {
child.renameTo(entry.getName()); child.renameTo(entry.getName());
@ -1651,9 +1682,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#replace(java.lang.String, java.io.File, java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void replace(String fullVirtualName, File file, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void replace(String fullVirtualName, File file, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
@ -1750,9 +1782,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#delete(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public boolean delete(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public boolean delete(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -1851,9 +1884,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return true; return true;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#rename(java.lang.String, java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void rename(String fullVirtualName, String newName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void rename(String fullVirtualName, String newName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName); fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName);
@ -1873,9 +1907,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
setArchiveOperationMonitorStatusDone(archiveOperationMonitor); setArchiveOperationMonitorStatusDone(archiveOperationMonitor);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#move(java.lang.String, java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void move(String fullVirtualName, String destinationVirtualPath, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void move(String fullVirtualName, String destinationVirtualPath, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName); fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName);
@ -1894,9 +1929,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#fullRename(java.lang.String, java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void fullRename(String fullVirtualName, String newFullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void fullRename(String fullVirtualName, String newFullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
@ -2109,10 +2145,13 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* Changes the name of a tar entry. Also calculates the new checksum for the entry. * Changes the name of a tar entry. Also calculates the new checksum for the
* entry.
*
* @param entry the entry for which the name has to be changed. * @param entry the entry for which the name has to be changed.
* @param newName the new name for the entry. * @param newName the new name for the entry.
* @return the changed entry. * @return the changed entry.
* @since 3.0 TarEntry moved into API
*/ */
protected TarEntry changeTarEntryName(TarEntry entry, String newName) { protected TarEntry changeTarEntryName(TarEntry entry, String newName) {
@ -2125,9 +2164,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return entry; return entry;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getFiles(java.lang.String[], org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public File[] getFiles(String[] fullNames, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public File[] getFiles(String[] fullNames, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
@ -2159,9 +2199,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return files; return files;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#createFolder(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void createFolder(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void createFolder(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName); fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName);
@ -2173,9 +2214,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#createFile(java.lang.String, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void createFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { public void createFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName); fullVirtualName = ArchiveHandlerManager.cleanUpVirtualPath(fullVirtualName);
@ -2280,11 +2322,14 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
/** /**
* Creates a new tar entry and appends it to the tar output stream with the given name. * Creates a new tar entry and appends it to the tar output stream with the
* given name.
*
* @param outStream the tar output stream. * @param outStream the tar output stream.
* @param name the name of the new tar entry. * @param name the name of the new tar entry.
* @return the newly created tar entry. * @return the newly created tar entry.
* @throws IOException if an I/O error occurs. * @throws IOException if an I/O error occurs.
* @since 3.0 TarEntry moved into API
*/ */
protected TarEntry appendEmptyFile(TarOutputStream outStream, String name) throws IOException { protected TarEntry appendEmptyFile(TarOutputStream outStream, String name) throws IOException {
@ -2359,9 +2404,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return vc.fullName; return vc.fullName;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#create() *
* @since 3.0
*/ */
public void create() throws SystemMessageException { public void create() throws SystemMessageException {
@ -2384,6 +2430,11 @@ public class SystemTarHandler implements ISystemArchiveHandler {
} }
} }
/**
* {@inheritDoc}
*
* @since 3.0
*/
public SystemSearchLineMatch[] search(String fullVirtualName, SystemSearchStringMatcher matcher, ISystemOperationMonitor archiveOperationMonitor) public SystemSearchLineMatch[] search(String fullVirtualName, SystemSearchStringMatcher matcher, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException { throws SystemMessageException {
// if the search string is empty or if it is "*", then return no matches // if the search string is empty or if it is "*", then return no matches
@ -2494,8 +2545,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
add(file, virtualPath, name, archiveOperationMonitor); add(file, virtualPath, name, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void add(File file, String virtualPath, String name, public void add(File file, String virtualPath, String name,
String sourceEncoding, String targetEncoding, boolean isText, String sourceEncoding, String targetEncoding, boolean isText,
@ -2503,8 +2556,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
add(file, virtualPath, name, archiveOperationMonitor); add(file, virtualPath, name, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File[], java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[], boolean[]) * {@inheritDoc}
*
* @since 3.0
*/ */
public void add(File[] files, String virtualPath, String[] names, public void add(File[] files, String virtualPath, String[] names,
String[] sourceEncodings, String[] targetEncodings, boolean[] isTexts, String[] sourceEncodings, String[] targetEncodings, boolean[] isTexts,
@ -2512,8 +2567,10 @@ public class SystemTarHandler implements ISystemArchiveHandler {
add(files, virtualPath, names, archiveOperationMonitor); add(files, virtualPath, names, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.io.File, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, public void extractVirtualDirectory(String dir, File destinationParent,
File destination, String sourceEncoding, boolean isText, File destination, String sourceEncoding, boolean isText,
@ -2521,16 +2578,20 @@ public class SystemTarHandler implements ISystemArchiveHandler {
extractVirtualDirectory(dir, destinationParent, destination, archiveOperationMonitor); extractVirtualDirectory(dir, destinationParent, destination, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, String sourceEncoding, boolean isText, public void extractVirtualDirectory(String dir, File destinationParent, String sourceEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
extractVirtualDirectory(dir, destinationParent, archiveOperationMonitor); extractVirtualDirectory(dir, destinationParent, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualFile(java.lang.String, java.io.File, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualFile(String fullVirtualName, File destination, String sourceEncoding, boolean isText, public void extractVirtualFile(String fullVirtualName, File destination, String sourceEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
@ -2596,16 +2657,31 @@ public class SystemTarHandler implements ISystemArchiveHandler {
return type; return type;
} }
/**
* {@inheritDoc}
*
* @since 3.0
*/
public void add(InputStream stream, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText, public void add(InputStream stream, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
throw new SystemUnsupportedOperationException(IClientServerConstants.PLUGIN_ID, "add"); //$NON-NLS-1$ throw new SystemUnsupportedOperationException(IClientServerConstants.PLUGIN_ID, "add"); //$NON-NLS-1$
} }
/**
* {@inheritDoc}
*
* @since 3.0
*/
public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, ISystemFileTypes typeRegistery, public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, ISystemFileTypes typeRegistery,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
add(file, virtualPath, name, archiveOperationMonitor); add(file, virtualPath, name, archiveOperationMonitor);
} }
/**
* {@inheritDoc}
*
* @since 3.0
*/
public void replace(String fullVirtualName, InputStream stream, String name, String sourceEncoding, String targetEncoding, boolean isText, public void replace(String fullVirtualName, InputStream stream, String name, String sourceEncoding, String targetEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException { ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException {
throw new SystemUnsupportedOperationException(IClientServerConstants.PLUGIN_ID, "replace"); //$NON-NLS-1$ throw new SystemUnsupportedOperationException(IClientServerConstants.PLUGIN_ID, "replace"); //$NON-NLS-1$

182
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/archiveutils/SystemZipHandler.java
View file

@ -509,8 +509,9 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildrenList() * {@inheritDoc}
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildrenList(ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public VirtualChild[] getVirtualChildrenList(ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -571,8 +572,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return new VirtualChild[0]; return new VirtualChild[0];
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildrenList(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildrenList(String parent, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public VirtualChild[] getVirtualChildrenList(String parent, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -641,8 +644,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildren(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildren(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) public VirtualChild[] getVirtualChildren(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor)
{ {
@ -665,8 +670,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return values; return values;
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualChildFolders(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public VirtualChild[] getVirtualChildFolders(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) public VirtualChild[] getVirtualChildFolders(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor)
{ {
@ -692,8 +699,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return values; return values;
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getVirtualFile(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public VirtualChild getVirtualFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) public VirtualChild getVirtualFile(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor)
{ {
@ -722,8 +731,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return vc; return vc;
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#exists(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public boolean exists(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public boolean exists(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -859,16 +870,20 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualFile(java.lang.String, java.io.File) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualFile(String fullVirtualName, File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void extractVirtualFile(String fullVirtualName, File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
extractVirtualFile(fullVirtualName, destination, true, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor); extractVirtualFile(fullVirtualName, destination, true, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualFile(java.lang.String, java.io.File, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualFile(String fullVirtualName, File destination, String sourceEncoding, boolean isText, public void extractVirtualFile(String fullVirtualName, File destination, String sourceEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -974,16 +989,20 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void extractVirtualDirectory(String dir, File destinationParent, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
extractVirtualDirectory(dir, destinationParent, (File) null, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor); extractVirtualDirectory(dir, destinationParent, (File) null, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.lang.String, boolean) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, String sourceEncoding, boolean isText, public void extractVirtualDirectory(String dir, File destinationParent, String sourceEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -991,8 +1010,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
extractVirtualDirectory(dir, destinationParent, (File) null, sourceEncoding, isText, archiveOperationMonitor); extractVirtualDirectory(dir, destinationParent, (File) null, sourceEncoding, isText, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.io.File) * {@inheritDoc}
*
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, File destination, ISystemOperationMonitor archiveOperationMonitor) public void extractVirtualDirectory(String dir, File destinationParent, File destination, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException throws SystemMessageException
@ -1000,9 +1021,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
extractVirtualDirectory(dir, destinationParent, destination, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor); extractVirtualDirectory(dir, destinationParent, destination, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#extractVirtualDirectory(java.lang.String, java.io.File, java.io.File, java.lang.String, boolean, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void extractVirtualDirectory(String dir, File destinationParent, File destination, String sourceEncoding, boolean isText, public void extractVirtualDirectory(String dir, File destinationParent, File destination, String sourceEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -1134,6 +1156,7 @@ public class SystemZipHandler implements ISystemArchiveHandler
* *
* @param file An abstract file handle to create physically. * @param file An abstract file handle to create physically.
* @throws SystemMessageException in case of an error otherwise. * @throws SystemMessageException in case of an error otherwise.
* @since 3.0 throws SystemMessageException
*/ */
protected void createFile(File file) throws SystemMessageException protected void createFile(File file) throws SystemMessageException
{ {
@ -1161,17 +1184,20 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File, java.lang.String, java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void add(File file, String virtualPath, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void add(File file, String virtualPath, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
add(file, virtualPath, name, SystemEncodingUtil.ENCODING_UTF_8, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor); add(file, virtualPath, name, SystemEncodingUtil.ENCODING_UTF_8, SystemEncodingUtil.ENCODING_UTF_8, false, archiveOperationMonitor);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.InputStream, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(InputStream stream, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText, public void add(InputStream stream, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -1253,8 +1279,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File[], java.lang.String, java.lang.String[]) * {@inheritDoc}
*
* @since 3.0
*/ */
public void add(File[] files, String virtualPath, String[] names, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void add(File[] files, String virtualPath, String[] names, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -1268,9 +1296,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
add(files, virtualPath, names, encodings, encodings, isTexts, true, archiveOperationMonitor); add(files, virtualPath, names, encodings, encodings, isTexts, true, archiveOperationMonitor);
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File[], java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[], boolean[], org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(File[] files, String virtualPath, String[] names, String[] sourceEncodings, String[] targetEncodings, boolean[] isText, public void add(File[] files, String virtualPath, String[] names, String[] sourceEncodings, String[] targetEncodings, boolean[] isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -1701,8 +1730,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
oldFile.delete(); oldFile.delete();
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#delete(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public boolean delete(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public boolean delete(String fullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -1835,8 +1866,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return; return;
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#replace(java.lang.String, java.io.File, java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void replace(String fullVirtualName, File file, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void replace(String fullVirtualName, File file, String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -1920,9 +1953,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#replace(java.lang.String, java.io.InputStream, java.lang.String, java.lang.String, java.lang.String, boolean, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void replace(String fullVirtualName, InputStream stream, String name, String sourceEncoding, String targetEncoding, boolean isText, public void replace(String fullVirtualName, InputStream stream, String name, String sourceEncoding, String targetEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -1985,8 +2019,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#fullRename(java.lang.String, java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void fullRename(String fullVirtualName, String newFullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void fullRename(String fullVirtualName, String newFullVirtualName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2104,8 +2140,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#move(java.lang.String, java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void move(String fullVirtualName, String destinationVirtualPath, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void move(String fullVirtualName, String destinationVirtualPath, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2120,8 +2158,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
fullRename(fullVirtualName, destinationVirtualPath + name, archiveOperationMonitor); fullRename(fullVirtualName, destinationVirtualPath + name, archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#rename(java.lang.String, java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void rename(String fullVirtualName, String newName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void rename(String fullVirtualName, String newName, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2138,8 +2178,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#getFiles(java.lang.String[]) * {@inheritDoc}
*
* @since 3.0
*/ */
public File[] getFiles(String[] fullNames, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public File[] getFiles(String[] fullNames, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2174,8 +2216,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return files; return files;
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#createFolder(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void createFolder(String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void createFolder(String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2185,8 +2229,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
setArchiveOperationMonitorStatusDone(archiveOperationMonitor); setArchiveOperationMonitorStatusDone(archiveOperationMonitor);
} }
/* (non-Javadoc) /**
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#createFile(java.lang.String) * {@inheritDoc}
*
* @since 3.0
*/ */
public void createFile(String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void createFile(String name, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -2409,9 +2455,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return entry; return entry;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#create() *
* @since 3.0
*/ */
public void create() throws SystemMessageException public void create() throws SystemMessageException
{ {
@ -2440,9 +2487,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
_exists = true; _exists = true;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#search(java.lang.String, org.eclipse.rse.services.clientserver.search.SystemSearchStringMatcher, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public SystemSearchLineMatch[] search(String fullVirtualName, SystemSearchStringMatcher matcher, ISystemOperationMonitor archiveOperationMonitor) public SystemSearchLineMatch[] search(String fullVirtualName, SystemSearchStringMatcher matcher, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException throws SystemMessageException
@ -2686,9 +2734,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
return type; return type;
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.eclipse.rse.services.clientserver.ISystemFileTypes, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, ISystemFileTypes registry, public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, ISystemFileTypes registry,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
@ -2767,9 +2816,10 @@ public class SystemZipHandler implements ISystemArchiveHandler
} }
} }
/* /**
* (non-Javadoc) * {@inheritDoc}
* @see org.eclipse.rse.services.clientserver.archiveutils.ISystemArchiveHandler#add(java.io.File, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, org.eclipse.rse.services.clientserver.ISystemOperationMonitor) *
* @since 3.0
*/ */
public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText, public void add(File file, String virtualPath, String name, String sourceEncoding, String targetEncoding, boolean isText,
ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException

21
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/archiveutils/VirtualChild.java
View file

@ -124,6 +124,7 @@ public final class VirtualChild {
/** /**
* @param value the time stamp value * @param value the time stamp value
* @since 3.0
*/ */
public void setTimeStamp(long value) public void setTimeStamp(long value)
{ {
@ -145,6 +146,7 @@ public final class VirtualChild {
/** /**
* @param value the size value * @param value the size value
* @since 3.0
*/ */
public void setSize(long value) public void setSize(long value)
{ {
@ -165,6 +167,7 @@ public final class VirtualChild {
/** /**
* @param value the comment value * @param value the comment value
* @since 3.0
*/ */
public void setComment(String value) public void setComment(String value)
{ {
@ -193,6 +196,7 @@ public final class VirtualChild {
/** /**
* @param value the compressedSize value * @param value the compressedSize value
* @since 3.0
*/ */
public void setCompressedSize(long value) public void setCompressedSize(long value)
{ {
@ -213,6 +217,7 @@ public final class VirtualChild {
/** /**
* @param value the compression method value * @param value the compression method value
* @since 3.0
*/ */
public void setCompressionMethod(String value) public void setCompressionMethod(String value)
{ {
@ -263,11 +268,13 @@ public final class VirtualChild {
} }
/** /**
* @return The extracted file or directory represented by this VirtualChild from the archive. * @return The extracted file or directory represented by this VirtualChild
* Assumes that the file has been encoded in the encoding specified. * from the archive. Assumes that the file has been encoded in the
* Note that the extracted file is cached after it is extracted once, but if the * encoding specified. Note that the extracted file is cached after
* timestamps on the cached and archived files do not match, the cached file is erased, * it is extracted once, but if the timestamps on the cached and
* and reextracted from the archive. * archived files do not match, the cached file is erased, and
* re-extracted from the archive.
* @since 3.0 throws SystemMessageException
*/ */
public File getExtractedFile(String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public File getExtractedFile(String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -341,10 +348,11 @@ public final class VirtualChild {
* <code>destination</code> with that extracted file or directory. Note that * <code>destination</code> with that extracted file or directory. Note that
* the extracted file is cached after it is extracted once, but if the * the extracted file is cached after it is extracted once, but if the
* timestamps on the cached and archived files do not match, the cached file * timestamps on the cached and archived files do not match, the cached file
* is erased, and reextracted from the archive. <code>destination</code> is * is erased, and re-extracted from the archive. <code>destination</code> is
* always overwritten with either what is cached, or what is in the archive. * always overwritten with either what is cached, or what is in the archive.
* *
* @throws SystemMessageException in case of an error * @throws SystemMessageException in case of an error
* @since 3.0 throws SystemMessageException
*/ */
public void getExtractedFile(File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException public void getExtractedFile(File destination, ISystemOperationMonitor archiveOperationMonitor) throws SystemMessageException
{ {
@ -362,6 +370,7 @@ public final class VirtualChild {
* always overwritten with either what is cached, or what is in the archive. * always overwritten with either what is cached, or what is in the archive.
* *
* @throws SystemMessageException in case of an error * @throws SystemMessageException in case of an error
* @since 3.0 throws SystemMessageException
*/ */
public void getExtractedFile(File destination, String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor) public void getExtractedFile(File destination, String sourceEncoding, boolean isText, ISystemOperationMonitor archiveOperationMonitor)
throws SystemMessageException throws SystemMessageException