FileEntry.Folder (Datasystems API)

java.lang.Object
- org.openide.loaders.MultiDataObject.Entry
- - org.openide.loaders.FileEntry.Folder

Enclosing class:

FileEntry
```
public static final class FileEntry.Folder
extends MultiDataObject.Entry
```
Simple entry for handling folders, on copy, move and createFromTemplate it creates new empty folder and copies attributes of source folder. Operation on children should be performed explicitly by DataObject using this entry.

Since:

1.13

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Folder(MultiDataObject obj, org.openide.filesystems.FileObject fo)
Creates new FolderEntry

Constructors
Constructor	Description
`Folder(MultiDataObject obj, org.openide.filesystems.FileObject fo)`	Creates new FolderEntry

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.openide.filesystems.FileObject`	`copy(org.openide.filesystems.FileObject f, java.lang.String suffix)`	Creates new folder and copies attributes.
`org.openide.filesystems.FileObject`	`createFromTemplate(org.openide.filesystems.FileObject f, java.lang.String name)`	Creates new folder and copies attributes, the template flag is cleared.
`void`	`delete()`	Deletes folder associated with entry.
`org.openide.filesystems.FileObject`	`move(org.openide.filesystems.FileObject f, java.lang.String suffix)`	Nearly the same like `(FileObject f, String suffix)`.
`org.openide.filesystems.FileObject`	`rename(java.lang.String name)`	Renames folder.

Methods inherited from class org.openide.loaders.MultiDataObject.Entry
copyRename, equals, getDataObject, getFile, hashCode, isImportant, isLocked, takeLock, writeReplace

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Folder
```
public Folder(MultiDataObject obj,
              org.openide.filesystems.FileObject fo)
```
    Creates new FolderEntry
- Method Detail
  - copy
```
public org.openide.filesystems.FileObject copy(org.openide.filesystems.FileObject f,
                                               java.lang.String suffix)
                                        throws java.io.IOException
```
    Creates new folder and copies attributes.
    
    Specified by:
    
    copy in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to create this entry in
    
    suffix - suffix appended to the new name to use
    
    Returns:
    
    the copied FileObject or null if it cannot be copied
    
    Throws:
    
    java.io.IOException - when the operation fails
  - move
```
public org.openide.filesystems.FileObject move(org.openide.filesystems.FileObject f,
                                               java.lang.String suffix)
                                        throws java.io.IOException
```
    Nearly the same like (FileObject f, String suffix).
    
    Specified by:
    
    move in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to move this entry to
    
    suffix - suffix appended to the new name to use
    
    Returns:
    
    the moved FileObject or null if it has been deleted
    
    Throws:
    
    java.io.IOException - when the operation fails
  - createFromTemplate
```
public org.openide.filesystems.FileObject createFromTemplate(org.openide.filesystems.FileObject f,
                                                             java.lang.String name)
                                                      throws java.io.IOException
```
    Creates new folder and copies attributes, the template flag is cleared.
    
    Specified by:
    
    createFromTemplate in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to create this entry in
    
    name - the new name to use
    
    Returns:
    
    the copied FileObject or null if it cannot be copied
    
    Throws:
    
    java.io.IOException - when the operation fails
  - rename
```
public org.openide.filesystems.FileObject rename(java.lang.String name)
                                          throws java.io.IOException
```
    Renames folder.
    
    Specified by:
    
    rename in class MultiDataObject.Entry
    
    Parameters:
    
    name - the new name
    
    Returns:
    
    the renamed FileObject or null if it has been deleted
    
    Throws:
    
    java.io.IOException - when the operation fails
  - delete
```
public void delete()
            throws java.io.IOException
```
    Deletes folder associated with entry. Although filesystems delete folders recursively, it is better to delete children DataObjects before the {@link #FileEntry.Folder} entry is deleted.
    
    Specified by:
    
    delete in class MultiDataObject.Entry
    
    Throws:
    
    java.io.IOException - when the operation fails

Class FileEntry.Folder

Constructor Summary

Method Summary

Methods inherited from class org.openide.loaders.MultiDataObject.Entry

Methods inherited from class java.lang.Object

Constructor Detail

Folder

Method Detail

copy

move

createFromTemplate

rename

delete