Disk (JaplSE 0.9.2, Java API for AppleScript System Events generated by JaplScript 3.4.11)

All Superinterfaces:: DiskItem, Reference

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

A disk in the file system.

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`	`countAliass()`
`int`	`countAliass(String filter)`
`default int`	`countDiskItems()`
`int`	`countDiskItems(String filter)`
`default int`	`countFilePackages()`
`int`	`countFilePackages(String filter)`
`default int`	`countFiles()`
`int`	`countFiles(String filter)`
`default int`	`countFolders()`
`int`	`countFolders(String filter)`
`default int`	`countItems()`
`int`	`countItems(String filter)`
`Alias`	`getAlias(int index)`
`Alias`	`getAlias(Id id)`
`default Alias[]`	`getAliass()`
`Alias[]`	`getAliass(String filter)`
`double`	`getCapacity()`	The total number of bytes (free or used) on the disk.
`DiskItem`	`getDiskItem(int index)`
`DiskItem`	`getDiskItem(Id id)`
`default DiskItem[]`	`getDiskItems()`
`DiskItem[]`	`getDiskItems(String filter)`
`File`	`getFile(int index)`
`File`	`getFile(Id id)`
`FilePackage`	`getFilePackage(int index)`
`FilePackage`	`getFilePackage(Id id)`
`default FilePackage[]`	`getFilePackages()`
`FilePackage[]`	`getFilePackages(String filter)`
`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 file system format of this disk.
`double`	`getFreeSpace()`	The number of free bytes left on the disk.
`Reference`	`getItem(int index)`
`Reference`	`getItem(Id id)`
`default Reference[]`	`getItems()`
`Reference[]`	`getItems(String filter)`
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`Reference`	`getServer()`	The server on which the disk resides, AFP volumes only.
`Reference`	`getZone()`	The zone in which the disk's server resides, AFP volumes only.
`boolean`	`isEjectable()`	Can the media be ejected (floppies, CD's, and so on)?
`boolean`	`isIgnorePrivileges()`	Ignore permissions on this disk?
`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.systemevents.DiskItem
getContainer, getCreationDate, getDisplayedName, getId, getModificationDate, getName, getNameExtension, getPath, getPhysicalSize, getPosixPath, getSize, getUrl, getVolume, isBusyStatus, isPackageFolder, isVisible, setModificationDate, setName, setVisible

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

- Field Detail
  - CLASS
```
static final TypeClass CLASS
```
- Method Detail
  - getAliass
```
@Kind("element")
@Type("alias")
default Alias[] getAliass()
```
    Returns:
    
    an array of all Aliass
  - getAliass
```
@Kind("element")
@Type("alias")
Alias[] getAliass(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Aliass
  - getAlias
```
@Kind("element")
@Type("alias")
Alias getAlias(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Alias at the requested index
  - getAlias
```
@Kind("element")
@Type("alias")
Alias getAlias(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Alias with the requested id
  - countAliass
```
@Kind("element")
@Type("alias")
default int countAliass()
```
    Returns:
    
    number of all Aliass
  - countAliass
```
@Kind("element")
@Type("alias")
int countAliass(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getDiskItems
```
@Kind("element")
@Type("disk item")
default DiskItem[] getDiskItems()
```
    Returns:
    
    an array of all DiskItems
  - getDiskItems
```
@Kind("element")
@Type("disk item")
DiskItem[] getDiskItems(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all DiskItems
  - getDiskItem
```
@Kind("element")
@Type("disk item")
DiskItem getDiskItem(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the DiskItem at the requested index
  - getDiskItem
```
@Kind("element")
@Type("disk item")
DiskItem getDiskItem(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the DiskItem with the requested id
  - countDiskItems
```
@Kind("element")
@Type("disk item")
default int countDiskItems()
```
    Returns:
    
    number of all DiskItems
  - countDiskItems
```
@Kind("element")
@Type("disk item")
int countDiskItems(String filter)
```
    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()
```
    Returns:
    
    an array of all Files
  - getFiles
```
@Kind("element")
@Type("file")
File[] getFiles(String filter)
```
    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)
```
    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)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the File with the requested id
  - countFiles
```
@Kind("element")
@Type("file")
default int countFiles()
```
    Returns:
    
    number of all Files
  - countFiles
```
@Kind("element")
@Type("file")
int countFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getFilePackages
```
@Kind("element")
@Type("file package")
default FilePackage[] getFilePackages()
```
    Returns:
    
    an array of all FilePackages
  - getFilePackages
```
@Kind("element")
@Type("file package")
FilePackage[] getFilePackages(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all FilePackages
  - getFilePackage
```
@Kind("element")
@Type("file package")
FilePackage getFilePackage(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the FilePackage at the requested index
  - getFilePackage
```
@Kind("element")
@Type("file package")
FilePackage getFilePackage(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the FilePackage with the requested id
  - countFilePackages
```
@Kind("element")
@Type("file package")
default int countFilePackages()
```
    Returns:
    
    number of all FilePackages
  - countFilePackages
```
@Kind("element")
@Type("file package")
int countFilePackages(String filter)
```
    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()
```
    Returns:
    
    an array of all Folders
  - getFolders
```
@Kind("element")
@Type("folder")
Folder[] getFolders(String filter)
```
    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)
```
    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)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Folder with the requested id
  - countFolders
```
@Kind("element")
@Type("folder")
default int countFolders()
```
    Returns:
    
    number of all Folders
  - countFolders
```
@Kind("element")
@Type("folder")
int countFolders(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getItems
```
@Kind("element")
@Type("item")
default Reference[] getItems()
```
    Returns:
    
    an array of all References
  - getItems
```
@Kind("element")
@Type("item")
Reference[] getItems(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all References
  - getItem
```
@Kind("element")
@Type("item")
Reference getItem(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Reference at the requested index
  - getItem
```
@Kind("element")
@Type("item")
Reference getItem(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Reference with the requested id
  - countItems
```
@Kind("element")
@Type("item")
default int countItems()
```
    Returns:
    
    number of all References
  - countItems
```
@Kind("element")
@Type("item")
int countItems(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getCapacity
```
@Code("capa")
@Kind("property")
@Name("capacity")
@Type("number")
double getCapacity()
```
    The total number of bytes (free or used) on the disk.
    
    Returns:
    
    property value
  - isEjectable
```
@Code("isej")
@Kind("property")
@Name("ejectable")
@Type("boolean")
boolean isEjectable()
```
    Can the media be ejected (floppies, CD's, and so on)?
    
    Returns:
    
    property value
  - getFormat
```
@Code("dfmt")
@Kind("property")
@Name("format")
@Type("edfm")
Edfm getFormat()
```
    The file system format of this disk.
    
    Returns:
    
    property value
  - getFreeSpace
```
@Code("frsp")
@Kind("property")
@Name("free space")
@Type("number")
double getFreeSpace()
```
    The number of free bytes left on the disk.
    
    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
  - 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
  - getServer
```
@Code("srvr")
@Kind("property")
@Name("server")
@Type("any")
Reference getServer()
```
    The server on which the disk resides, AFP volumes only.
    
    Returns:
    
    property value
  - isStartup
```
@Code("istd")
@Kind("property")
@Name("startup")
@Type("boolean")
boolean isStartup()
```
    Is this disk the boot disk?
    
    Returns:
    
    property value
  - getZone
```
@Code("zone")
@Kind("property")
@Name("zone")
@Type("any")
Reference getZone()
```
    The zone in which the disk's server resides, AFP volumes only.
    
    Returns:
    
    property value
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns all properties for an instance of this class.
    
    Specified by:
    
    getProperties in interface DiskItem
    
    Returns:
    
    Map containing all properties

Interface Disk

Field Summary

Method Summary

Methods inherited from interface com.tagtraum.macos.systemevents.DiskItem

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

Method Detail

getAliass

getAliass

getAlias

getAlias

countAliass

countAliass

getDiskItems

getDiskItems

getDiskItem

getDiskItem

countDiskItems

countDiskItems

getFiles

getFiles

getFile

getFile

countFiles

countFiles

getFilePackages

getFilePackages

getFilePackage

getFilePackage

countFilePackages

countFilePackages

getFolders

getFolders

getFolder

getFolder

countFolders

countFolders

getItems

getItems

getItem

getItem

countItems

countItems

getCapacity

isEjectable

getFormat

getFreeSpace

isIgnorePrivileges

setIgnorePrivileges

isLocalVolume

getServer

isStartup

getZone

getProperties