Class: DirectoryContents

• Inheritance
• Description
• Related information
• Class protocol
  • accessing
  • cache flushing
  • constants
  • initialization
  • instance creation
  • private
  • queries
  • utilities
• Instance protocol
  • accessing
  • enumerating
  • instance creation
  • obsolete
  • printing
  • queries
  • testing
• Private classes

Inheritance:

   Object
   |
   +--DirectoryContents

Package:

stx:libbasic2

Category:

System-Support

Version:

rev: 1.56 date: 2010/02/03 15:24:01

user: cg

file: DirectoryContents.st directory: libbasic2

module: stx stc-classLibrary: libbasic2

Author:

Claus Atzkern

Description:

DirectoryContents provides a cached view onto a fileDirectory.


Notice:
    This class is not available in other ST-systems;
    Applications using it may not be portable.

Related information:

    Filename
    FileStream
    DirectoryStream
    OperatingSystem

Class protocol:

 cachedDirectoryNamed: aFileOrString

answer the valid cached directory or nil

 directoryNamed: aDirectory

returns the DirectoryContents for a directory named
aDirectoryName, aString, nil or Filename

 flushCache

flush list of remembered directory contents

 flushCachedDirectoryFor: aDirectoryOrString

remove directory from cache

 lowSpaceCleanup

flush list of remembered directory contents when low on memory

 preSnapshot

flush list of cached directory contents before saving a snapshot

 maxCachedDirectories

returns number of maximum cached directories

 initialize

setup lock-mechanism

 new

 accessKeyForDirectory: aDirectoryOrString

computes a fast access key to retrieve the directory in the cache

 directoryAt: aFileOrString

checks whether directory already exists and is valid.
If true the directory is returned otherwise nil

 directoryAt: aFileOrString checkForValidContentsDo: checkIsValidBlock

answer the directoryContents stored under aFileOrString in the cache.
If the evaluation of the checkIsValidBlock returns false, the contents
will be removed from the cache and nil is returned.

 directoryNamed: aDirectoryName detect: aTwoArgBlock

evaluate the block, [:filename :isDirectory] on the directory
contents of a directory named aDirectoryName, until the block
returns true. If nothing detected false is returned

 directoryNamed: aDirectoryName detect: aTwoArgBlock onOpenErrorDo: exceptionBlock

evaluate the block, [:filename :isDirectory] on the directory
contents of a directory named aDirectoryName, until the block
returns true. If nothing detected false is returned.

if the directory cannot be open, the exceptionBlock is processed
with the filename.

 contentsItemForFileName: aFilenameOrString

Instance protocol:

 accessKey

 beObsolete

mark self as obsolete
clear contents and reset time

 directory

returns the directoy name as Filename

 modificationTime

get the last modification time of the directory

 timeStamp

get the last timeStamp (when the directory info was read) of the directory

 contentsAndBaseNamesDo: aThreeArgBlock

evaluate the block on each file; the argument to the block is the
filename, the baseName and true in case of a directory
block arguments: [:fileName :aBaseName :isDirectory|

 contentsDo: aTwoArgBlock

evaluate the block on each file; the argument to the block is the
filename and true in case of a directory
block arguments: [:fileName :isDirectory|

 directoriesAndBasenamesDo: aTwoArgBlock

evaluate block on each directory; a Filename and Basename.
The directories are sorted

 directoriesDo: aOneArgBlock

evaluate block on each directory; a Filename. The directories are sorted

 filesAndBasenamesDo: aTwoArgBlock

evaluate block on each file; a Filename and a Basename.
The files are sorted.

 filesDo: aOneArgBlock

evaluate block on each file; a Filename. The files are sorted.

 itemsDo: aBlock

evaluate the block on each contentsItem, which contains the fileName and type info

 directory: aFilename

instance creation; setup attributes

 updateContents

 printOn: aStream

 isObsolete

returns true if the directory contents represented by the receiver is obsolete
(i.e. if the fileSystems directory has been changed in the meanwhile)

 isReadable

answer true if the directory is readable
no open error raised during reading the directory

 isRootDirectory

 size

get number of files including directories in the directory

 includesIdentical: anItem

 isEmpty

returns true if directory is empty

 isEmptyOrNil

returns true if directory is empty

 notEmpty

returns true if directory is not empty

 notEmptyOrNil

returns true if directory is not empty

Private classes:

    DirectoryContentsItem