FileEntry (Datasystems API)

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

Direct Known Subclasses:

FileEntry.Format
```
public class FileEntry
extends MultiDataObject.Entry
```
Entry that works with plain files. Copies, moves, renames and deletes them without any modification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`FileEntry.Folder`	Simple entry for handling folders, on copy, move and createFromTemplate it creates new empty folder and copies attributes of source folder.
`static class`	`FileEntry.Format`	Specialized entry that simplifies substitution when a file entry is created from template.
`static class`	`FileEntry.Numb`	Simple file entry variant.

Constructor Summary

Constructors
Constructor Description

FileEntry(MultiDataObject obj, org.openide.filesystems.FileObject fo)
Creates new file entry initially attached to a given file object.

Constructors
Constructor	Description
`FileEntry(MultiDataObject obj, org.openide.filesystems.FileObject fo)`	Creates new file entry initially attached to a given file object.

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)`	Called when the entry is to be copied.
`org.openide.filesystems.FileObject`	`copyRename(org.openide.filesystems.FileObject f, java.lang.String name, java.lang.String ext)`	Called when the entry is to be copied and renamed.
`org.openide.filesystems.FileObject`	`createFromTemplate(org.openide.filesystems.FileObject f, java.lang.String name)`	Called when the entry is to be created from a template.
`void`	`delete()`	Called when the entry is to be deleted.
`org.openide.filesystems.FileObject`	`move(org.openide.filesystems.FileObject f, java.lang.String suffix)`	Called when the entry is to be moved.
`org.openide.filesystems.FileObject`	`rename(java.lang.String name)`	Called when the entry is to be renamed.

Methods inherited from class org.openide.loaders.MultiDataObject.Entry
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
  - FileEntry
```
public FileEntry(MultiDataObject obj,
                 org.openide.filesystems.FileObject fo)
```
    Creates new file entry initially attached to a given file object.
    
    Parameters:
    
    obj - the data object this entry belongs to
    
    fo - the file object for the entry
- Method Detail
  - copy
```
public org.openide.filesystems.FileObject copy(org.openide.filesystems.FileObject f,
                                               java.lang.String suffix)
                                        throws java.io.IOException
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be copied. Depending on the entry type, it should either copy the underlying FileObject, or do nothing (if it cannot be copied).
    
    Specified by:
    
    copy in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to create this entry in
    
    suffix - the suffix to add to the name of original file
    
    Returns:
    
    the copied FileObject or null if it cannot be copied
    
    Throws:
    
    java.io.IOException - when the operation fails
  - copyRename
```
public org.openide.filesystems.FileObject copyRename(org.openide.filesystems.FileObject f,
                                                     java.lang.String name,
                                                     java.lang.String ext)
                                              throws java.io.IOException
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be copied and renamed.
    
    Overrides:
    
    copyRename in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to create this entry in
    
    name - new file name
    
    ext - new file extension
    
    Returns:
    
    the copied and renamed FileObject, never null
    
    Throws:
    
    java.io.IOException - when the operation fails
  - rename
```
public org.openide.filesystems.FileObject rename(java.lang.String name)
                                          throws java.io.IOException
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be renamed. Depending on the entry type, it should either rename the underlying FileObject, or delete it (if it cannot be renamed).
    
    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
  - move
```
public org.openide.filesystems.FileObject move(org.openide.filesystems.FileObject f,
                                               java.lang.String suffix)
                                        throws java.io.IOException
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be moved. Depending on the entry type, it should either move the underlying FileObject, or delete it (if it cannot be moved).
    
    Specified by:
    
    move in class MultiDataObject.Entry
    
    Parameters:
    
    f - the folder to move this entry to
    
    suffix - the suffix to use
    
    Returns:
    
    the moved FileObject or null if it has been deleted
    
    Throws:
    
    java.io.IOException - when the operation fails
  - delete
```
public void delete()
            throws java.io.IOException
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be deleted.
    
    Specified by:
    
    delete in class MultiDataObject.Entry
    
    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
```
    Description copied from class: MultiDataObject.Entry
    
    Called when the entry is to be created from a template. Depending on the entry type, it should either copy the underlying FileObject, or do nothing (if it cannot be copied).
    
    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

Class FileEntry

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

FileEntry

Method Detail

copy

copyRename

rename

move

delete

createFromTemplate