|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.File
pivot.io.Folder
public class Folder
Class representing a folder in the file system.
NOTE Because Java does not provide any way to monitor the file system for
changes, instances of this class must be refreshed periodically to reflect
updates. Instances must also be refreshed to perform initial population
immediately after construction. See refresh()
.
Nested Class Summary | |
---|---|
static class |
Folder.FileNameComparator
Default file name comparator. |
Nested classes/interfaces inherited from interface pivot.collections.List |
---|
List.ListListenerList<T> |
Nested classes/interfaces inherited from interface pivot.collections.Sequence |
---|
Sequence.Search, Sequence.Sort, Sequence.Tree |
Field Summary |
---|
Fields inherited from class java.io.File |
---|
pathSeparator, pathSeparatorChar, separator, separatorChar |
Constructor Summary | |
---|---|
Folder()
|
|
Folder(FileFilter fileFilter)
|
|
Folder(String pathname)
|
|
Folder(String pathname,
FileFilter fileFilter)
|
Method Summary | |
---|---|
int |
add(File file)
This method is not supported. |
void |
clear()
This method is not supported. |
File |
get(int index)
Retrieves the item at the given index. |
Comparator<File> |
getComparator()
Returns the collection's sort order. |
FileFilter |
getFileFilter()
Returns the file filter that is applied to this folder. |
int |
getLength()
Returns the length of the list. |
ListenerList<ListListener<File>> |
getListListeners()
Returns the list listener list. |
int |
indexOf(File file)
Returns the index of an item in the sequence. |
void |
insert(File file,
int index)
This method is not supported. |
Iterator<File> |
iterator()
|
void |
refresh()
Refreshes the file list by requerying the file system for the current contents. |
int |
remove(File file)
This method is not supported. |
Sequence<File> |
remove(int index,
int count)
This method is not supported. |
void |
setComparator(Comparator<File> comparator)
Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order. |
File |
update(int index,
File file)
This method is not supported. |
Methods inherited from class java.io.File |
---|
canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Folder()
public Folder(FileFilter fileFilter)
public Folder(String pathname)
public Folder(String pathname, FileFilter fileFilter)
Method Detail |
---|
public FileFilter getFileFilter()
public int add(File file)
add
in interface List<File>
add
in interface Sequence<File>
file
- The item to be added to the sequence.
ListListener.itemInserted(List, int)
public void insert(File file, int index)
insert
in interface List<File>
insert
in interface Sequence<File>
file
- The item to be added to the list.index
- The index at which the item should be inserted. Must be a value between
0 and getLength().ListListener.itemInserted(List, int)
public File update(int index, File file)
update
in interface List<File>
update
in interface Sequence<File>
index
- The index of the item to update.file
- The item that will replace any existing value at the given index.
ListListener.itemUpdated(List, int, Object)
public int remove(File file)
remove
in interface Sequence<File>
file
- The item to remove.
Sequence.remove(int, int)
public Sequence<File> remove(int index, int count)
remove
in interface List<File>
remove
in interface Sequence<File>
index
- The starting index to remove.count
- The number of items to remove, beginning with index.
ListListener.itemsRemoved(List, int, Sequence)
public void clear()
clear
in interface Collection<File>
clear
in interface List<File>
ListListener.itemsRemoved(List, int, Sequence)
public File get(int index)
Sequence
get
in interface Sequence<File>
index
- The index of the item to retrieve.public int indexOf(File file)
Sequence
indexOf
in interface Sequence<File>
file
- The item to locate.
public int getLength()
List
getLength
in interface List<File>
getLength
in interface Sequence<File>
public Comparator<File> getComparator()
Collection
getComparator
in interface Collection<File>
Collection.setComparator(Comparator)
public void setComparator(Comparator<File> comparator)
Collection
setComparator
in interface Collection<File>
setComparator
in interface List<File>
comparator
- The comparator used to order elements in the collection, or null if the
collection is unsorted.ListListener.comparatorChanged(List, Comparator)
public void refresh()
public Iterator<File> iterator()
iterator
in interface Iterable<File>
public ListenerList<ListListener<File>> getListListeners()
List
getListListeners
in interface List<File>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |