A B C D F G H I K L M N O P R S T U V W

A

addFileData(long, long, byte[]) - Method in interface org.biffle.cliff.pearl.FileDataListener

Supplies the listener with more data from the file.

addFileInfo(FileInfo) - Method in interface org.biffle.cliff.pearl.FileInfoListener

Supplies the listener with another FileInfo object.

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl.listeners.VectorFileInfoListener

Callback for inserting a FileInfo object.

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl.listeners.MaxFIDFileInfoListener

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl.listeners.FilterFileInfoListener

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl.tools.ScrubLost.Tracker

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl2.listeners.ProgressFileInfoListener

addFileInfo(FileInfo) - Method in class org.biffle.cliff.pearl2.FileInfoCache

AUTH_REQUIRED - Static variable in class org.biffle.cliff.pearl.FailureException

AUTHENTICATE - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Authenticate message.

authenticate(String) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Attempts to authenticate using a given password.

authenticate(String) - Method in interface org.biffle.cliff.pearl.PearlConnection

Attempts to authenticate using a given password.

authenticate(String) - Method in class org.biffle.cliff.pearl.tools.Client

Attempts to authenticate the connection using the provided password.

authenticated - Variable in class org.biffle.cliff.pearl.PearlTCPConnection

AuthHandler - interface org.biffle.cliff.pearl2.AuthHandler.

Implemented by objects that provide authorization services to the Pearl2 library.

B

BUSY - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Busy message.

C

Client - class org.biffle.cliff.pearl.tools.Client.

Implements a simple command-line interface to a PearlConnection, primarily to demonstrate the use of the APIs and exception cases.

Client(InetAddress) - Constructor for class org.biffle.cliff.pearl.tools.Client

Creates a new Client, connecting to a Pearl device via TCP.

close() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

close() - Method in interface org.biffle.cliff.pearl.PearlConnection

Closes a connection.

close() - Method in class org.biffle.cliff.pearl.tools.Client

Closes the connection.

close() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Closes a connection.

con - Variable in class org.biffle.cliff.pearl.tools.Client

Our connection to the device.

ConsoleAuthHandler - class org.biffle.cliff.pearl2.handlers.ConsoleAuthHandler.

Implemented by objects that provide authorization services to the Pearl2 library.

ConsoleAuthHandler() - Constructor for class org.biffle.cliff.pearl2.handlers.ConsoleAuthHandler

ConsoleProgressHandler - class org.biffle.cliff.pearl2.handlers.ConsoleProgressHandler.

Displays progress indicator on the console.

ConsoleProgressHandler() - Constructor for class org.biffle.cliff.pearl2.handlers.ConsoleProgressHandler

containsProperty(String) - Method in class org.biffle.cliff.pearl.PropSet

Checks if the PropSet contains a given property.

containsProperty(String) - Method in class org.biffle.cliff.pearl.DeviceSettings

D

DELETE_FILE - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Delete File message.

delete(String) - Method in class org.biffle.cliff.pearl.tools.Client

Attempts to delete a file by FID.

deleteFile(int) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Removes a file from the device.

deleteFile(int) - Method in interface org.biffle.cliff.pearl.PearlConnection

Removes a file from the device.

deleteFile(int) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

deleteFile(int) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Removes a file from the device.

DeviceInfo - class org.biffle.cliff.pearl.DeviceInfo.

Provides details on a Pearl device.

DeviceInfo(String, String, int) - Constructor for class org.biffle.cliff.pearl.DeviceInfo

DeviceSettings - class org.biffle.cliff.pearl.DeviceSettings.

Wrapper for the Device Settings properties file returned from the Pearl device.

DeviceSettings(String) - Constructor for class org.biffle.cliff.pearl.DeviceSettings

Creates a new DeviceSettings object based on property text from the device.

downloadInfo() - Method in class org.biffle.cliff.pearl.tools.Client

Caches device info.

downloadSettings() - Method in class org.biffle.cliff.pearl.tools.Client

Caches device settings.

dump(String) - Method in class org.biffle.cliff.pearl.tools.Client

Dumps the first 16k of a file.

F

failure() - Method in class org.biffle.cliff.pearl.Message

Checks whether or not this message indicates failure.

FailureException - exception org.biffle.cliff.pearl.FailureException.

Thrown when a Pearl command returns a normal response with a failure status code.

FailureException(int) - Constructor for class org.biffle.cliff.pearl.FailureException

Creates a new FailureException, drawing a status code from a section of a byte array.

FailureException(String, int) - Constructor for class org.biffle.cliff.pearl.FailureException

Creates a new FailureException with a message, drawing a status code from a section of a byte array.

fetch(String) - Method in class org.biffle.cliff.pearl.tools.Client

Retrieves a file to local storage.

FileDataListener - interface org.biffle.cliff.pearl.FileDataListener.

Used by objects that handle callbacks while a PearlConnection implementation is receiving a file.

FileInfo - class org.biffle.cliff.pearl.FileInfo.

Wrapper for a file metainfo properties file.

FileInfo(String) - Constructor for class org.biffle.cliff.pearl.FileInfo

Creates a new FileInfo object based on property text from the device.

FileInfoCache - class org.biffle.cliff.pearl2.FileInfoCache.

FileInfoCache.FileInfoIterator - class org.biffle.cliff.pearl2.FileInfoCache.FileInfoIterator.

FileInfoCache() - Constructor for class org.biffle.cliff.pearl2.FileInfoCache

FileInfoCache(long) - Constructor for class org.biffle.cliff.pearl2.FileInfoCache

FileInfoListener - interface org.biffle.cliff.pearl.FileInfoListener.

Used by objects that handle FileInfo callbacks from PearlConnection.

FilterFileInfoListener - class org.biffle.cliff.pearl.listeners.FilterFileInfoListener.

FilterFileInfoListener(FileInfoListener, String, String) - Constructor for class org.biffle.cliff.pearl.listeners.FilterFileInfoListener

G

GET_ALL_FILE_INFO - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get All File Info message.

GET_DATABASE_LOCK - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get Database Lock message.

GET_DEVICE_INFO - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get Device Info message.

GET_DEVICE_SETTINGS - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get Device Settings message.

GET_FILE_INFO - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get File Info message.

GET_SALT - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get Salt message.

GET_STORAGE_INFO - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Get Storage Info message.

getAlbum() - Method in class org.biffle.cliff.pearl.FileInfo

Returns a song's album source.

getAllFileInfo(FileInfoListener) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Retrieves all file information from the device using a callback mechanism.

getAllFileInfo(FileInfoListener) - Method in interface org.biffle.cliff.pearl.PearlConnection

Retrieves all file information from the device using a callback mechanism.

getArtist() - Method in class org.biffle.cliff.pearl.FileInfo

Returns a song's artist.

getAvailableSpace() - Method in class org.biffle.cliff.pearl.StorageInfo

Returns the available space on the storage device, in bytes.

getBitrate() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the bitrate of an audio file, in kilobits per second.

getBytes(String) - Method in class org.biffle.cliff.pearl.PropSet

Returns the value of a property as a list of bytes.

getCacheDirForSerial(long) - Static method in class org.biffle.cliff.pearl2.FileInfoCache

getCachePath() - Static method in class org.biffle.cliff.pearl2.FileInfoCache

getCapabilities() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device's reported capabilities as an array of String tokens.

getCodec() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the short name of the codec used for this file.

getCodecs() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device's supported codecs as an array of String tokens.

getCount() - Method in class org.biffle.cliff.pearl.tools.ScrubLost.Tracker

getCreationTime() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the time the file was created on the device, as a Unix-style timestamp.

getDeviceGeneration() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device generation -- the time its contents were last modified as a Unix-style timestamp.

getDeviceID() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device ID.

getDeviceInfo() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Returns an object encapsulating basic device information -- number of storage devices, system software name, and firmware version.

getDeviceInfo() - Method in interface org.biffle.cliff.pearl.PearlConnection

Returns an object encapsulating basic device information -- number of storage devices, system software name, and firmware version.

getDeviceInfo() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns an object encapsulating basic device information -- number of storage devices, system software name, and firmware version.

getDeviceSettings() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Retrieves the Pearl device's settings as a DeviceSettings object.

getDeviceSettings() - Method in interface org.biffle.cliff.pearl.PearlConnection

Retrieves the Pearl device's settings as a DeviceSettings object.

getDeviceSettings() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Retrieves the Pearl device's settings as a DeviceSettings object.

getDuration() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the play time of the file in milliseconds.

getExpectedMajor() - Method in class org.biffle.cliff.pearl.VersionException

getExpectedMinor() - Method in class org.biffle.cliff.pearl.VersionException

getFID() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the unique File ID (FID) for the file.

getFIDGeneration() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the time this FID was allocated as a Unix-style timestamp.

getFIDs() - Method in class org.biffle.cliff.pearl.tools.ScrubLost.Tracker

getFileByFID(int) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

getFileByFID(int) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns a file by FID, or null if no such FID exists.

getFileByFID(int) - Method in class org.biffle.cliff.pearl2.FileInfoCache

getFileCount() - Method in class org.biffle.cliff.pearl.StorageInfo

Returns the number of files available on the storage device.

getFileCount() - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

getFileCount() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns the number of files available on the device.

getFileCount() - Method in class org.biffle.cliff.pearl2.FileInfoCache

getFileInfo(int) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Retrieves information on a single file, by FID.

getFileInfo(int) - Method in interface org.biffle.cliff.pearl.PearlConnection

Retrieves information on a single file, by FID.

getFileIterator() - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

getFileIterator() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns an iterator for the known files.

getFirmwareVersion() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device's current firmware version.

getGeneration() - Method in class org.biffle.cliff.pearl2.FileInfoCache

getGenre() - Method in class org.biffle.cliff.pearl.FileInfo

Returns a song's recorded genre.

getHardwareRevision() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the device's reported hardware revision.

getHighestFID() - Method in class org.biffle.cliff.pearl.StorageInfo

Returns the highest FID currently in use on the storage device.

getLastPlayTime() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the time the file was last played (all the way through), as a Unix-style timestamp.

getLEInt(byte[], int) - Static method in class org.biffle.cliff.pearl.Util

Converts four bytes from an array (representing a little-endian integer) into an int.

getLELong(byte[], int) - Static method in class org.biffle.cliff.pearl.Util

Converts eight bytes from an array (representing a little-endian long) into a long.

getLong(String) - Method in class org.biffle.cliff.pearl.PropSet

Returns the value of a property as a long.

getLong(String) - Method in class org.biffle.cliff.pearl.DeviceSettings

Raw property access.

getManufacturer() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the name of the device's manufacturer.

getMarked() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the 'Marked for Attention' flag.

getMaxFID() - Method in class org.biffle.cliff.pearl.listeners.MaxFIDFileInfoListener

getMaxFID() - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

getMaxFID() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns the highest allocated FID.

getMaxFID() - Method in class org.biffle.cliff.pearl2.FileInfoCache

getMaxPlaylistEntries() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the maximum number of playlist entries the device supports.

getMessage() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

getName() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the name of the device (the model).

getName() - Method in class org.biffle.cliff.pearl.DeviceInfo

Returns the system name.

getNullTermString() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

getOffset() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the 'offset' field.

getOptions() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the 'options' field, which is a bitmask of flags, most of which are unknown.

getPayload() - Method in class org.biffle.cliff.pearl.Message

Returns the message payload.

getPlayCount() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the number of times a song has been played all the way through.

getPlayCountLimit() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the maximum number of times a song can be played all the way through (a technique for DRM restriction), or zero if the song is unrestricted.

getProfile() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the waveform profile of a song as a byte array.

getProfilerVersion() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the version of the profiling algorithm that was used to generate the waveform profile (getProfile()), RMS (getRMS()), and standard deviation (getStdDev()).

getReceivedMajor() - Method in class org.biffle.cliff.pearl.VersionException

getReceivedMinor() - Method in class org.biffle.cliff.pearl.VersionException

getRecovery() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns a flag indicating whether or not the device is in recovery mode.

getRID() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the file's RID, a hash of three segments of the file.

getRMS() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the file's mean 'loudness', as computed by the root-mean-square algorithm.

getRNSPrefix() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the rns_prefix field.

getRNSVersion() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the rns_version field.

getSampleRate() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the sample rate the decoded PCM stream for a song.

getSerial() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the serial field.

getSize() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the size of the file in bytes.

getStatus() - Method in class org.biffle.cliff.pearl.FailureException

getStdDev() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the song's standard deviation from the mean loudness given by getRMS().

getStorageDeviceCount() - Method in class org.biffle.cliff.pearl.DeviceInfo

Returns the number of storage devices available.

getStorageInfo(int) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Retrieves information about a storage device in the Pearl device.

getStorageInfo(int) - Method in interface org.biffle.cliff.pearl.PearlConnection

Retrieves information about a storage device in the Pearl device.

getStorageInfo(int) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Retrieves information about a storage device in the Pearl device.

getStorageName() - Method in class org.biffle.cliff.pearl.DeviceSettings

Returns the name of the storage device.

getString(String) - Method in class org.biffle.cliff.pearl.PropSet

Returns the value of a property as a String.

getString(String) - Method in class org.biffle.cliff.pearl.FileInfo

getString(String) - Method in class org.biffle.cliff.pearl.DeviceSettings

Raw property access.

getStringList(String) - Method in class org.biffle.cliff.pearl.PropSet

Returns the value of a property as a list of Strings.

getTarget() - Method in class org.biffle.cliff.pearl.listeners.FilterFileInfoListener

getTitle() - Method in class org.biffle.cliff.pearl.FileInfo

Returns a song's title.

getTotalSpace() - Method in class org.biffle.cliff.pearl.StorageInfo

Returns the total space on the storage device, in bytes.

getTrackNumber() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the song's track number on the source album.

getTrailer() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the 'trailer' field.

getType() - Method in class org.biffle.cliff.pearl.Message

Returns the type of the message.

getType() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the file type.

getVector() - Method in class org.biffle.cliff.pearl.listeners.VectorFileInfoListener

Returns the Vector being used.

getVersion() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Returns the version of the protocol being used as an array of two integers: the major and minor versions, respectively.

getVersion() - Method in interface org.biffle.cliff.pearl.PearlConnection

Returns the version of the protocol being used as an array of two integers: the major and minor versions, respectively.

getVersion() - Method in class org.biffle.cliff.pearl.DeviceInfo

Returns the system version.

getVersion() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Returns the version of the protocol being used as an array of two integers: the major and minor versions, respectively.

getYear() - Method in class org.biffle.cliff.pearl.FileInfo

Returns the 'year' field from the song's metadata.

H

hasNext() - Method in class org.biffle.cliff.pearl2.FileInfoCache.FileInfoIterator

I

info - Variable in class org.biffle.cliff.pearl.tools.Client

Cached copy of the device's info (created lazily).

invalidate() - Method in class org.biffle.cliff.pearl2.FileInfoCache

isAuthenticated() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Checks to see if the underlying session has been successfully authenticated.

isAuthenticated() - Method in interface org.biffle.cliff.pearl.PearlConnection

Checks to see if the underlying session has been successfully authenticated.

isAuthenticated() - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Checks to see if the underlying session has been successfully authenticated.

isBitrateVariable() - Method in class org.biffle.cliff.pearl.FileInfo

Determines whether a file is encoded with Variable BitRate encoding (true) or Constant BitRate encoding (false).

iterator() - Method in class org.biffle.cliff.pearl2.FileInfoCache

K

keySet() - Method in class org.biffle.cliff.pearl.PropSet

Returns the property names as a Set.

L

LOCK_REQUIRED - Static variable in class org.biffle.cliff.pearl.FailureException

lockDatabase(int) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

M

main(String[]) - Static method in class org.biffle.cliff.pearl.tools.ScrubLost

Main function executed from the command line; walks the user through the scrub process.

main(String[]) - Static method in class org.biffle.cliff.pearl.tools.Client

Main function executed from the command line; takes one argument (an IP address) and spawns a Client.

main(String[]) - Static method in class org.biffle.cliff.pearl2.tools.TaxiTool2

MaxFIDFileInfoListener - class org.biffle.cliff.pearl.listeners.MaxFIDFileInfoListener.

MaxFIDFileInfoListener() - Constructor for class org.biffle.cliff.pearl.listeners.MaxFIDFileInfoListener

MaxFIDFileInfoListener(FileInfoListener) - Constructor for class org.biffle.cliff.pearl.listeners.MaxFIDFileInfoListener

Message - class org.biffle.cliff.pearl.Message.

Represents a Pearl protocol message.

Message(int, byte[]) - Constructor for class org.biffle.cliff.pearl.Message

Creates a new message of a given type, with an optional payload.

Message(int, byte[], boolean) - Constructor for class org.biffle.cliff.pearl.Message

Creates a new message of a given type, with an optional payload, and a flag indicating whether or not it indicates failure.

msg(String) - Method in class org.biffle.cliff.pearl.tools.Client

Utility function; prints a message from the Client (rather than data from the device).

N

NAK - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for NAK message.

NAKException - exception org.biffle.cliff.pearl.NAKException.

Thrown when the Pearl device replies to a command with a NAK message.

NAKException(int) - Constructor for class org.biffle.cliff.pearl.NAKException

Creates a new NAKException.

next() - Method in class org.biffle.cliff.pearl2.FileInfoCache.FileInfoIterator

NOT_FOUND - Static variable in class org.biffle.cliff.pearl.FailureException

O

org.biffle.cliff.pearl - package org.biffle.cliff.pearl

This package provides various interfaces to devices using the Pearl protocol.

org.biffle.cliff.pearl.listeners - package org.biffle.cliff.pearl.listeners

Provides listener classes that can be chained together to perform multiple actions in response to a single callback, including filtering the callback.

org.biffle.cliff.pearl.tools - package org.biffle.cliff.pearl.tools

Provides a set of simple programs demonstrating the use of the PearlLib Layer I interface.

org.biffle.cliff.pearl2 - package org.biffle.cliff.pearl2

This package provides higher-level interfaces to devices using the Pearl protocol.

org.biffle.cliff.pearl2.handlers - package org.biffle.cliff.pearl2.handlers

Provides utility classes that implement the PearlLib Layer II handler interfaces.

org.biffle.cliff.pearl2.listeners - package org.biffle.cliff.pearl2.listeners

Provides utility classes that implement the PearlLib Layer II listener interfaces.

org.biffle.cliff.pearl2.tools - package org.biffle.cliff.pearl2.tools

Contains example programs using the Layer II PearlLib interface.

P

parseString(String) - Method in class org.biffle.cliff.pearl2.FileInfoCache

PASSWORD_INCORRECT - Static variable in class org.biffle.cliff.pearl.FailureException

passwordNeeded() - Method in class org.biffle.cliff.pearl2.handlers.ConsoleAuthHandler

Called when a password is needed for authentication.

passwordNeeded() - Method in interface org.biffle.cliff.pearl2.AuthHandler

Called when a password is needed for authentication.

Pearl2Connection - interface org.biffle.cliff.pearl2.Pearl2Connection.

Pearl2TCPConnection - class org.biffle.cliff.pearl2.Pearl2TCPConnection.

A wrapper for PearlTCPConnection that provides the Pearl2Connection level of functionality, including data caching/validation, progress and authentication handlers, and simplified file transfer.

Pearl2TCPConnection(InetAddress, int) - Constructor for class org.biffle.cliff.pearl2.Pearl2TCPConnection

Creates a new Pearl2TCPConnection to the given device and port.

PearlConnection - interface org.biffle.cliff.pearl.PearlConnection.

Objects implementing PearlConnection provide a reasonably low-level interface to the Pearl protocol, with no caching.

PearlException - exception org.biffle.cliff.pearl.PearlException.

Thrown when something goes awry in the Pearl protocol internals.

PearlException(String) - Constructor for class org.biffle.cliff.pearl.PearlException

Creates a new PearlException with a message.

PearlIOException - exception org.biffle.cliff.pearl.PearlIOException.

Used as a wrapper for unexpected IOExceptions thrown during Pearl processing.

PearlIOException(IOException) - Constructor for class org.biffle.cliff.pearl.PearlIOException

Creates a new PearlIOException.

PearlTCPConnection - class org.biffle.cliff.pearl.PearlTCPConnection.

Provides a TCP implementation of the Pearl protocol.

PearlTCPConnection(InetAddress, int) - Constructor for class org.biffle.cliff.pearl.PearlTCPConnection

progress(int, int) - Method in interface org.biffle.cliff.pearl.ProgressListener

Sets a new progress level in relation to the max.

ProgressFileInfoListener - class org.biffle.cliff.pearl2.listeners.ProgressFileInfoListener.

ProgressFileInfoListener(String, ProgressHandler, long, FileInfoListener) - Constructor for class org.biffle.cliff.pearl2.listeners.ProgressFileInfoListener

ProgressHandler - interface org.biffle.cliff.pearl2.ProgressHandler.

Implemented by objects that display progress updates for some Pearl function.

ProgressListener - interface org.biffle.cliff.pearl.ProgressListener.

Implemented by objects that handle command-progress callbacks from PearlConnection.

propertySet() - Method in class org.biffle.cliff.pearl.DeviceSettings

props - Variable in class org.biffle.cliff.pearl.FileInfo

PropSet - class org.biffle.cliff.pearl.PropSet.

Encapsulates the 'properties files' used by Pearl devices for both device settings and file metadata.

PropSet(String) - Constructor for class org.biffle.cliff.pearl.PropSet

Creates a PropSet from its textual representation.

PROTOCOL_VERSION - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Protocol Version message.

putLEInt(int, byte[], int) - Static method in class org.biffle.cliff.pearl.Util

Writes an int into a byte array as a little-endian integer.

putLELong(long, byte[], int) - Static method in class org.biffle.cliff.pearl.Util

Writes a long into a byte array as a little-endian long.

R

READ - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Read message.

readFile(int, File) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

readFile(int, File) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Downloads a file from the device by FID.

readFileChunk(int, long, long, byte[]) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Retrieves a chunk of a file into a supplied buffer.

readFileChunk(int, long, long, byte[]) - Method in interface org.biffle.cliff.pearl.PearlConnection

Retrieves a chunk of a file into a supplied buffer.

readLock - Variable in class org.biffle.cliff.pearl.PearlTCPConnection

RELEASE_DATABASE_LOCK - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Release Database Lock message.

remove() - Method in class org.biffle.cliff.pearl2.FileInfoCache.FileInfoIterator

requireAuth() - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

ridOfFile(RandomAccessFile) - Static method in class org.biffle.cliff.pearl.Util

Computes the RID (a sort of quick hash) of a file.

run() - Method in class org.biffle.cliff.pearl.tools.Client

The meat of the client; this function is executed in its own thread and provides the console interface.

S

saki - Variable in class org.biffle.cliff.pearl.PearlTCPConnection

The socket used to communicate with the Pearl device.

save() - Method in class org.biffle.cliff.pearl2.FileInfoCache

ScrubLost - class org.biffle.cliff.pearl.tools.ScrubLost.

A simple command-line tool to find and remove 'lost' files on a Pearl device.

ScrubLost.Tracker - class org.biffle.cliff.pearl.tools.ScrubLost.Tracker.

ScrubLost.Tracker() - Constructor for class org.biffle.cliff.pearl.tools.ScrubLost.Tracker

ScrubLost() - Constructor for class org.biffle.cliff.pearl.tools.ScrubLost

sendMessage(Message) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

SET_FILE_INFO - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Set File Info message.

setAuthHandler(AuthHandler) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

setAuthHandler(AuthHandler) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Sets the AuthHandler to be used if authentication is required.

setFileInfo(int, FileInfo) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Updates information for a file identified by FID.

setFileInfo(int, FileInfo) - Method in interface org.biffle.cliff.pearl.PearlConnection

Updates information for a file identified by FID.

setFileInfo(int, FileInfo) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Updates information for a file identified by FID.

setGeneration(int) - Method in class org.biffle.cliff.pearl2.FileInfoCache

setProgressHandler(ProgressHandler) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

setProgressHandler(ProgressHandler) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Sets a library-global ProgressHandler.

setString(String, String) - Method in class org.biffle.cliff.pearl.PropSet

setString(String, String) - Method in class org.biffle.cliff.pearl.FileInfo

settings - Variable in class org.biffle.cliff.pearl.tools.Client

Cached copy of the device's settings (created lazily).

showField(String) - Method in class org.biffle.cliff.pearl.tools.Client

Displays a named field from the device settings file.

showFile(String) - Method in class org.biffle.cliff.pearl.tools.Client

Show file information.

showInfo(String) - Method in class org.biffle.cliff.pearl.tools.Client

Show system information.

showList(String) - Method in class org.biffle.cliff.pearl.tools.Client

Show list of available files.

showProgress(int, int) - Method in class org.biffle.cliff.pearl2.handlers.ConsoleProgressHandler

Called when progress occurs on the current task.

showProgress(int, int) - Method in interface org.biffle.cliff.pearl2.ProgressHandler

Called when progress occurs on the current task.

showStorage(String) - Method in class org.biffle.cliff.pearl.tools.Client

Displays information on a storage device by index, or a list of storage devices if no index is given.

signature - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Protocol signature (Rio, accented, in UTF-8)

startProgress(String) - Method in class org.biffle.cliff.pearl2.handlers.ConsoleProgressHandler

Called when a new task begins.

startProgress(String) - Method in interface org.biffle.cliff.pearl2.ProgressHandler

Called when a new task begins.

statusString(int) - Static method in class org.biffle.cliff.pearl.FailureException

stop() - Method in class org.biffle.cliff.pearl2.listeners.ProgressFileInfoListener

stopProgress() - Method in class org.biffle.cliff.pearl2.handlers.ConsoleProgressHandler

Called when a task completes.

stopProgress() - Method in interface org.biffle.cliff.pearl2.ProgressHandler

Called when a task completes.

StorageInfo - class org.biffle.cliff.pearl.StorageInfo.

Provides details on a storage device within the Pearl device.

StorageInfo(int, int, long, long) - Constructor for class org.biffle.cliff.pearl.StorageInfo

SUCCESS - Static variable in class org.biffle.cliff.pearl.FailureException

T

taxi(String) - Method in class org.biffle.cliff.pearl.tools.Client

Uploads a local taxi file.

TaxiTool2 - class org.biffle.cliff.pearl2.tools.TaxiTool2.

TaxiTool2() - Constructor for class org.biffle.cliff.pearl2.tools.TaxiTool2

toString() - Method in class org.biffle.cliff.pearl.PropSet

Converts the PropSet to a textual representation.

toString() - Method in class org.biffle.cliff.pearl.FileInfo

toString() - Method in class org.biffle.cliff.pearl2.FileInfoCache

U

UnexpectedResponseException - exception org.biffle.cliff.pearl.UnexpectedResponseException.

Thrown when the Pearl device sends a message other than what was expected -- namely, a message whose Message Type differs from the request.

UnexpectedResponseException(int, int) - Constructor for class org.biffle.cliff.pearl.UnexpectedResponseException

Creates a new UnexpectedResponseException with the expected message type and the message type received

UnexpectedResponseException(String, int, int) - Constructor for class org.biffle.cliff.pearl.UnexpectedResponseException

Creates a new UnexpectedResponseException with a text message, the expected message type, and the message type received.

unlockDatabase() - Method in class org.biffle.cliff.pearl.PearlTCPConnection

unmarkBad(String) - Method in class org.biffle.cliff.pearl.tools.Client

Attempts to un-mark a file as bad.

usage() - Static method in class org.biffle.cliff.pearl2.tools.TaxiTool2

Util - class org.biffle.cliff.pearl.Util.

Utility functions -- anything I found myself repeating over and over.

V

validateFileInfoCache() - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

VectorFileInfoListener - class org.biffle.cliff.pearl.listeners.VectorFileInfoListener.

A useful implementation of FileInfoListener that simply stores all reported FileInfo objects into a Vector.

VectorFileInfoListener() - Constructor for class org.biffle.cliff.pearl.listeners.VectorFileInfoListener

Creates a VectorFileInfoListener for a new Vector.

VectorFileInfoListener(Vector) - Constructor for class org.biffle.cliff.pearl.listeners.VectorFileInfoListener

Creates a VectorFileInfoListener for an existing Vector.

VersionException - exception org.biffle.cliff.pearl.VersionException.

Thrown when something goes awry in the Pearl protocol internals.

VersionException(int, int, int, int) - Constructor for class org.biffle.cliff.pearl.VersionException

Creates a new VersionException.

W

WRITE - Static variable in class org.biffle.cliff.pearl.PearlTCPConnection

Message type for Write message.

writeFile(File) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

writeFile(File) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Writes a local file to the device.

writeFileChunk(int, int, long, long, byte[]) - Method in class org.biffle.cliff.pearl.PearlTCPConnection

Writes a chunk of a file from a supplied buffer.

writeFileChunk(int, int, long, long, byte[]) - Method in interface org.biffle.cliff.pearl.PearlConnection

Writes a chunk of a file from a supplied buffer.

writeLock - Variable in class org.biffle.cliff.pearl.PearlTCPConnection

writeTaxiFile(File) - Method in class org.biffle.cliff.pearl2.Pearl2TCPConnection

writeTaxiFile(File) - Method in interface org.biffle.cliff.pearl2.Pearl2Connection

Writes a local file to the device without attempting to interpret the file as a song.

A B C D F G H I K L M N O P R S T U V W