Disk (Japlfind 0.9.4, Java API for Finder.app generated by JaplScript 3.4.11)

All Superinterfaces:: Container, Item, Reference

@Plural("disks")
@Code("cdis")
@Name("disk")
@Inherits("container")
public interface Disk
extends Reference, Container

A disk.

Author:: JaplScript 3.4.11

Field Summary

Fields
Modifier and Type Field Description

static TypeClass CLASS

Fields
Modifier and Type	Field	Description
`static TypeClass`	`CLASS`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`countAliasFiles()`
`int`	`countAliasFiles(String filter)`
`default int`	`countApplicationFiles()`
`int`	`countApplicationFiles(String filter)`
`default int`	`countClippings()`
`int`	`countClippings(String filter)`
`default int`	`countContainers()`
`int`	`countContainers(String filter)`
`default int`	`countDocumentFiles()`
`int`	`countDocumentFiles(String filter)`
`default int`	`countFiles()`
`int`	`countFiles(String filter)`
`default int`	`countFolders()`
`int`	`countFolders(String filter)`
`default int`	`countInternetLocationFiles()`
`int`	`countInternetLocationFiles(String filter)`
`default int`	`countItems()`
`int`	`countItems(String filter)`
`default int`	`countPackages()`
`int`	`countPackages(String filter)`
`AliasFile`	`getAliasFile(int index)`
`AliasFile`	`getAliasFile(Id id)`
`default AliasFile[]`	`getAliasFiles()`
`AliasFile[]`	`getAliasFiles(String filter)`
`ApplicationFile`	`getApplicationFile(int index)`
`ApplicationFile`	`getApplicationFile(Id id)`
`default ApplicationFile[]`	`getApplicationFiles()`
`ApplicationFile[]`	`getApplicationFiles(String filter)`
`long`	`getCapacity()`	The total number of bytes (free or used) on the disk.
`Clipping`	`getClipping(int index)`
`Clipping`	`getClipping(Id id)`
`default Clipping[]`	`getClippings()`
`Clipping[]`	`getClippings(String filter)`
`Container`	`getContainer(int index)`
`Container`	`getContainer(Id id)`
`default Container[]`	`getContainers()`
`Container[]`	`getContainers(String filter)`
`DocumentFile`	`getDocumentFile(int index)`
`DocumentFile`	`getDocumentFile(Id id)`
`default DocumentFile[]`	`getDocumentFiles()`
`DocumentFile[]`	`getDocumentFiles(String filter)`
`File`	`getFile(int index)`
`File`	`getFile(Id id)`
`default File[]`	`getFiles()`
`File[]`	`getFiles(String filter)`
`Folder`	`getFolder(int index)`
`Folder`	`getFolder(Id id)`
`default Folder[]`	`getFolders()`
`Folder[]`	`getFolders(String filter)`
`Edfm`	`getFormat()`	The filesystem format of this disk.
`long`	`getFreeSpace()`	The number of free bytes left on the disk.
`int`	`getId()`	The unique id for this disk (unchanged while disk remains connected and Finder remains running).
`InternetLocationFile`	`getInternetLocationFile(int index)`
`InternetLocationFile`	`getInternetLocationFile(Id id)`
`default InternetLocationFile[]`	`getInternetLocationFiles()`
`InternetLocationFile[]`	`getInternetLocationFiles(String filter)`
`Item`	`getItem(int index)`
`Item`	`getItem(Id id)`
`default Item[]`	`getItems()`
`Item[]`	`getItems(String filter)`
`Package`	`getPackage(int index)`
`Package`	`getPackage(Id id)`
`default Package[]`	`getPackages()`
`Package[]`	`getPackages(String filter)`
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`boolean`	`isEjectable()`	Can the media be ejected (floppies, CDs, and so on)?
`boolean`	`isIgnorePrivileges()`	Ignore permissions on this disk?
`boolean`	`isJournalingEnabled()`	Does this disk do file system journaling?
`boolean`	`isLocalVolume()`	Is the media a local volume (as opposed to a file server)?
`boolean`	`isStartup()`	Is this disk the boot disk?
`void`	`setIgnorePrivileges(boolean ignorePrivileges)`	Ignore permissions on this disk?

Methods inherited from interface com.tagtraum.macos.finder.Container
getContainerWindow, getEntireContents, isCompletelyExpanded, isExpandable, isExpanded, setCompletelyExpanded, setExpanded

Methods inherited from interface com.tagtraum.macos.finder.Item
getBounds, getComment, getContainer, getCreationDate, getDescription, getDesktopPosition, getDisk, getDisplayedName, getEveryonesPrivileges, getGroup, getGroupPrivileges, getIcon, getIndex, getInformationWindow, getKind, getKlass, getLabelIndex, getModificationDate, getName, getNameExtension, getOwner, getOwnerPrivileges, getPhysicalSize, getPosition, getSize, getUrl, isExtensionHidden, isLocked, setBounds, setComment, setDesktopPosition, setEveryonesPrivileges, setExtensionHidden, setGroup, setGroupPrivileges, setIcon, setLabelIndex, setLocked, setModificationDate, setName, setNameExtension, setOwner, setOwnerPrivileges, setPosition

Methods inherited from interface com.tagtraum.japlscript.Reference
cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

- Field Detail
  - CLASS
```
static final TypeClass CLASS
```
- Method Detail
  - getItems
```
@Kind("element")
@Type("item")
default Item[] getItems()
```
    Specified by:
    
    getItems in interface Container
    
    Returns:
    
    an array of all Items
  - getItems
```
@Kind("element")
@Type("item")
Item[] getItems(String filter)
```
    Specified by:
    
    getItems in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Items
  - getItem
```
@Kind("element")
@Type("item")
Item getItem(int index)
```
    Specified by:
    
    getItem in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Item at the requested index
  - getItem
```
@Kind("element")
@Type("item")
Item getItem(Id id)
```
    Specified by:
    
    getItem in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Item with the requested id
  - countItems
```
@Kind("element")
@Type("item")
default int countItems()
```
    Specified by:
    
    countItems in interface Container
    
    Returns:
    
    number of all Items
  - countItems
```
@Kind("element")
@Type("item")
int countItems(String filter)
```
    Specified by:
    
    countItems in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getContainers
```
@Kind("element")
@Type("container")
default Container[] getContainers()
```
    Specified by:
    
    getContainers in interface Container
    
    Returns:
    
    an array of all Containers
  - getContainers
```
@Kind("element")
@Type("container")
Container[] getContainers(String filter)
```
    Specified by:
    
    getContainers in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Containers
  - getContainer
```
@Kind("element")
@Type("container")
Container getContainer(int index)
```
    Specified by:
    
    getContainer in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Container at the requested index
  - getContainer
```
@Kind("element")
@Type("container")
Container getContainer(Id id)
```
    Specified by:
    
    getContainer in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Container with the requested id
  - countContainers
```
@Kind("element")
@Type("container")
default int countContainers()
```
    Specified by:
    
    countContainers in interface Container
    
    Returns:
    
    number of all Containers
  - countContainers
```
@Kind("element")
@Type("container")
int countContainers(String filter)
```
    Specified by:
    
    countContainers in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getFolders
```
@Kind("element")
@Type("folder")
default Folder[] getFolders()
```
    Specified by:
    
    getFolders in interface Container
    
    Returns:
    
    an array of all Folders
  - getFolders
```
@Kind("element")
@Type("folder")
Folder[] getFolders(String filter)
```
    Specified by:
    
    getFolders in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Folders
  - getFolder
```
@Kind("element")
@Type("folder")
Folder getFolder(int index)
```
    Specified by:
    
    getFolder in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Folder at the requested index
  - getFolder
```
@Kind("element")
@Type("folder")
Folder getFolder(Id id)
```
    Specified by:
    
    getFolder in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Folder with the requested id
  - countFolders
```
@Kind("element")
@Type("folder")
default int countFolders()
```
    Specified by:
    
    countFolders in interface Container
    
    Returns:
    
    number of all Folders
  - countFolders
```
@Kind("element")
@Type("folder")
int countFolders(String filter)
```
    Specified by:
    
    countFolders in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getFiles
```
@Kind("element")
@Type("file")
default File[] getFiles()
```
    Specified by:
    
    getFiles in interface Container
    
    Returns:
    
    an array of all Files
  - getFiles
```
@Kind("element")
@Type("file")
File[] getFiles(String filter)
```
    Specified by:
    
    getFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Files
  - getFile
```
@Kind("element")
@Type("file")
File getFile(int index)
```
    Specified by:
    
    getFile in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the File at the requested index
  - getFile
```
@Kind("element")
@Type("file")
File getFile(Id id)
```
    Specified by:
    
    getFile in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the File with the requested id
  - countFiles
```
@Kind("element")
@Type("file")
default int countFiles()
```
    Specified by:
    
    countFiles in interface Container
    
    Returns:
    
    number of all Files
  - countFiles
```
@Kind("element")
@Type("file")
int countFiles(String filter)
```
    Specified by:
    
    countFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getAliasFiles
```
@Kind("element")
@Type("alias file")
default AliasFile[] getAliasFiles()
```
    Specified by:
    
    getAliasFiles in interface Container
    
    Returns:
    
    an array of all AliasFiles
  - getAliasFiles
```
@Kind("element")
@Type("alias file")
AliasFile[] getAliasFiles(String filter)
```
    Specified by:
    
    getAliasFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all AliasFiles
  - getAliasFile
```
@Kind("element")
@Type("alias file")
AliasFile getAliasFile(int index)
```
    Specified by:
    
    getAliasFile in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the AliasFile at the requested index
  - getAliasFile
```
@Kind("element")
@Type("alias file")
AliasFile getAliasFile(Id id)
```
    Specified by:
    
    getAliasFile in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the AliasFile with the requested id
  - countAliasFiles
```
@Kind("element")
@Type("alias file")
default int countAliasFiles()
```
    Specified by:
    
    countAliasFiles in interface Container
    
    Returns:
    
    number of all AliasFiles
  - countAliasFiles
```
@Kind("element")
@Type("alias file")
int countAliasFiles(String filter)
```
    Specified by:
    
    countAliasFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getApplicationFiles
```
@Kind("element")
@Type("application file")
default ApplicationFile[] getApplicationFiles()
```
    Specified by:
    
    getApplicationFiles in interface Container
    
    Returns:
    
    an array of all ApplicationFiles
  - getApplicationFiles
```
@Kind("element")
@Type("application file")
ApplicationFile[] getApplicationFiles(String filter)
```
    Specified by:
    
    getApplicationFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all ApplicationFiles
  - getApplicationFile
```
@Kind("element")
@Type("application file")
ApplicationFile getApplicationFile(int index)
```
    Specified by:
    
    getApplicationFile in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the ApplicationFile at the requested index
  - getApplicationFile
```
@Kind("element")
@Type("application file")
ApplicationFile getApplicationFile(Id id)
```
    Specified by:
    
    getApplicationFile in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the ApplicationFile with the requested id
  - countApplicationFiles
```
@Kind("element")
@Type("application file")
default int countApplicationFiles()
```
    Specified by:
    
    countApplicationFiles in interface Container
    
    Returns:
    
    number of all ApplicationFiles
  - countApplicationFiles
```
@Kind("element")
@Type("application file")
int countApplicationFiles(String filter)
```
    Specified by:
    
    countApplicationFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getDocumentFiles
```
@Kind("element")
@Type("document file")
default DocumentFile[] getDocumentFiles()
```
    Specified by:
    
    getDocumentFiles in interface Container
    
    Returns:
    
    an array of all DocumentFiles
  - getDocumentFiles
```
@Kind("element")
@Type("document file")
DocumentFile[] getDocumentFiles(String filter)
```
    Specified by:
    
    getDocumentFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all DocumentFiles
  - getDocumentFile
```
@Kind("element")
@Type("document file")
DocumentFile getDocumentFile(int index)
```
    Specified by:
    
    getDocumentFile in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the DocumentFile at the requested index
  - getDocumentFile
```
@Kind("element")
@Type("document file")
DocumentFile getDocumentFile(Id id)
```
    Specified by:
    
    getDocumentFile in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the DocumentFile with the requested id
  - countDocumentFiles
```
@Kind("element")
@Type("document file")
default int countDocumentFiles()
```
    Specified by:
    
    countDocumentFiles in interface Container
    
    Returns:
    
    number of all DocumentFiles
  - countDocumentFiles
```
@Kind("element")
@Type("document file")
int countDocumentFiles(String filter)
```
    Specified by:
    
    countDocumentFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
default InternetLocationFile[] getInternetLocationFiles()
```
    Specified by:
    
    getInternetLocationFiles in interface Container
    
    Returns:
    
    an array of all InternetLocationFiles
  - getInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
InternetLocationFile[] getInternetLocationFiles(String filter)
```
    Specified by:
    
    getInternetLocationFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all InternetLocationFiles
  - getInternetLocationFile
```
@Kind("element")
@Type("internet location file")
InternetLocationFile getInternetLocationFile(int index)
```
    Specified by:
    
    getInternetLocationFile in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the InternetLocationFile at the requested index
  - getInternetLocationFile
```
@Kind("element")
@Type("internet location file")
InternetLocationFile getInternetLocationFile(Id id)
```
    Specified by:
    
    getInternetLocationFile in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the InternetLocationFile with the requested id
  - countInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
default int countInternetLocationFiles()
```
    Specified by:
    
    countInternetLocationFiles in interface Container
    
    Returns:
    
    number of all InternetLocationFiles
  - countInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
int countInternetLocationFiles(String filter)
```
    Specified by:
    
    countInternetLocationFiles in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getClippings
```
@Kind("element")
@Type("clipping")
default Clipping[] getClippings()
```
    Specified by:
    
    getClippings in interface Container
    
    Returns:
    
    an array of all Clippings
  - getClippings
```
@Kind("element")
@Type("clipping")
Clipping[] getClippings(String filter)
```
    Specified by:
    
    getClippings in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Clippings
  - getClipping
```
@Kind("element")
@Type("clipping")
Clipping getClipping(int index)
```
    Specified by:
    
    getClipping in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Clipping at the requested index
  - getClipping
```
@Kind("element")
@Type("clipping")
Clipping getClipping(Id id)
```
    Specified by:
    
    getClipping in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Clipping with the requested id
  - countClippings
```
@Kind("element")
@Type("clipping")
default int countClippings()
```
    Specified by:
    
    countClippings in interface Container
    
    Returns:
    
    number of all Clippings
  - countClippings
```
@Kind("element")
@Type("clipping")
int countClippings(String filter)
```
    Specified by:
    
    countClippings in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getPackages
```
@Kind("element")
@Type("package")
default Package[] getPackages()
```
    Specified by:
    
    getPackages in interface Container
    
    Returns:
    
    an array of all Packages
  - getPackages
```
@Kind("element")
@Type("package")
Package[] getPackages(String filter)
```
    Specified by:
    
    getPackages in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Packages
  - getPackage
```
@Kind("element")
@Type("package")
Package getPackage(int index)
```
    Specified by:
    
    getPackage in interface Container
    
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Package at the requested index
  - getPackage
```
@Kind("element")
@Type("package")
Package getPackage(Id id)
```
    Specified by:
    
    getPackage in interface Container
    
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Package with the requested id
  - countPackages
```
@Kind("element")
@Type("package")
default int countPackages()
```
    Specified by:
    
    countPackages in interface Container
    
    Returns:
    
    number of all Packages
  - countPackages
```
@Kind("element")
@Type("package")
int countPackages(String filter)
```
    Specified by:
    
    countPackages in interface Container
    
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getId
```
@Code("ID  ")
@Kind("property")
@Name("id")
@Type("integer")
int getId()
```
    The unique id for this disk (unchanged while disk remains connected and Finder remains running).
    
    Returns:
    
    property value
  - getCapacity
```
@Code("capa")
@Kind("property")
@Name("capacity")
@Type("double integer")
long getCapacity()
```
    The total number of bytes (free or used) on the disk.
    
    Returns:
    
    property value
  - getFreeSpace
```
@Code("frsp")
@Kind("property")
@Name("free space")
@Type("double integer")
long getFreeSpace()
```
    The number of free bytes left on the disk.
    
    Returns:
    
    property value
  - isEjectable
```
@Code("isej")
@Kind("property")
@Name("ejectable")
@Type("boolean")
boolean isEjectable()
```
    Can the media be ejected (floppies, CDs, and so on)?
    
    Returns:
    
    property value
  - isLocalVolume
```
@Code("isrv")
@Kind("property")
@Name("local volume")
@Type("boolean")
boolean isLocalVolume()
```
    Is the media a local volume (as opposed to a file server)?
    
    Returns:
    
    property value
  - isStartup
```
@Code("istd")
@Kind("property")
@Name("startup")
@Type("boolean")
boolean isStartup()
```
    Is this disk the boot disk?
    
    Returns:
    
    property value
  - getFormat
```
@Code("dfmt")
@Kind("property")
@Name("format")
@Type("edfm")
Edfm getFormat()
```
    The filesystem format of this disk.
    
    Returns:
    
    property value
  - isJournalingEnabled
```
@Code("Jrnl")
@Kind("property")
@Name("journaling enabled")
@Type("boolean")
boolean isJournalingEnabled()
```
    Does this disk do file system journaling?
    
    Returns:
    
    property value
  - isIgnorePrivileges
```
@Code("igpr")
@Kind("property")
@Name("ignore privileges")
@Type("boolean")
boolean isIgnorePrivileges()
```
    Ignore permissions on this disk?
    
    Returns:
    
    property value
  - setIgnorePrivileges
```
@Code("igpr")
@Kind("property")
@Name("ignore privileges")
@Type("boolean")
void setIgnorePrivileges(boolean ignorePrivileges)
```
    Ignore permissions on this disk?
    
    Parameters:
    
    ignorePrivileges - new property value
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns all properties for an instance of this class.
    
    Specified by:
    
    getProperties in interface Container
    
    Specified by:
    
    getProperties in interface Item
    
    Returns:
    
    Map containing all properties

Interface Disk

Field Summary

Method Summary

Methods inherited from interface com.tagtraum.macos.finder.Container

Methods inherited from interface com.tagtraum.macos.finder.Item

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

Method Detail

getItems

getItems

getItem

getItem

countItems

countItems

getContainers

getContainers

getContainer

getContainer

countContainers

countContainers

getFolders

getFolders

getFolder

getFolder

countFolders

countFolders

getFiles

getFiles

getFile

getFile

countFiles

countFiles

getAliasFiles

getAliasFiles

getAliasFile

getAliasFile

countAliasFiles

countAliasFiles

getApplicationFiles

getApplicationFiles

getApplicationFile

getApplicationFile

countApplicationFiles

countApplicationFiles

getDocumentFiles

getDocumentFiles

getDocumentFile

getDocumentFile

countDocumentFiles

countDocumentFiles

getInternetLocationFiles

getInternetLocationFiles

getInternetLocationFile

getInternetLocationFile

countInternetLocationFiles

countInternetLocationFiles

getClippings

getClippings

getClipping

getClipping

countClippings

countClippings

getPackages

getPackages

getPackage

getPackage

countPackages

countPackages

getId

getCapacity

getFreeSpace

isEjectable

isLocalVolume

isStartup

getFormat

isJournalingEnabled

isIgnorePrivileges

setIgnorePrivileges

getProperties