org.tanager.application
Class CDeleteSongResultEnum

java.lang.Object
  org.tanager.application.CDeleteSongResultEnum

public class CDeleteSongResultEnum
extends java.lang.Object

This class encapsulates the enumerations for the various return values from the Music Player's deleteSong() method.

Version:

$Revision: 1.2.2.3 $

Author:

Bob Lavey

See Also:

a template described in the July 1997 issue of Java World, http://www.javaworld.com/javaworld/jw-07-1997/jw-07-enumerated.html

Field Summary

static CDeleteSongResultEnum	CannotDeletePausedSong Represents an unsuccessful song deletion.
static CDeleteSongResultEnum	CannotDeletePausingSong Represents an unsuccessful song deletion.
static CDeleteSongResultEnum	CannotDeletePlayingSong Represents an unsuccessful song deletion.
static CDeleteSongResultEnum	CannotDeleteStoppingSong Represents an unsuccessful song deletion.
private java.lang.String	id_ The string representation of the deleteSong() return value.
static CDeleteSongResultEnum	SongDeleted Represents a sucessful song deletion.
static CDeleteSongResultEnum	SongNotFound Represents an unsuccessful song deletion.

Constructor Summary

private

CDeleteSongResultEnum(java.lang.String id) This is the only constructor allowed for a CDeleteSongResultEnum object.

Method Summary

boolean	equals(CDeleteSongResultEnum deleteSongResult) Returns whether or not the string representation of the given CDeleteSongResultEnum object equals our own.
java.lang.String	toString() Returns the string representation of the CDeleteSongResultEnum object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id_

private java.lang.String id_

The string representation of the deleteSong() return value.

SongDeleted

public static final CDeleteSongResultEnum SongDeleted

Represents a sucessful song deletion.

CannotDeletePlayingSong

public static final CDeleteSongResultEnum CannotDeletePlayingSong

Represents an unsuccessful song deletion. The song could not be deleted because it was currently playing.

CannotDeletePausedSong

public static final CDeleteSongResultEnum CannotDeletePausedSong

Represents an unsuccessful song deletion. The song could not be deleted because it was currently paused.

CannotDeletePausingSong

public static final CDeleteSongResultEnum CannotDeletePausingSong

Represents an unsuccessful song deletion. The song could not be deleted because it was currently pausing.

CannotDeleteStoppingSong

public static final CDeleteSongResultEnum CannotDeleteStoppingSong

Represents an unsuccessful song deletion. The song could not be deleted because it was currently stopping.

SongNotFound

public static final CDeleteSongResultEnum SongNotFound

Represents an unsuccessful song deletion. The song could not be deleted because it could not be found.

Constructor Detail

CDeleteSongResultEnum

private CDeleteSongResultEnum(java.lang.String id)

This is the only constructor allowed for a CDeleteSongResultEnum object.

Semantics:

1. save the given id

Parameters:

id - The string representation of the deleteSong() return value.

Method Detail

toString

public java.lang.String toString()

Returns the string representation of the CDeleteSongResultEnum object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the deleteSong() return value

equals

public boolean equals(CDeleteSongResultEnum deleteSongResult)

Returns whether or not the string representation of the given CDeleteSongResultEnum object equals our own.

Parameters:

deleteSongResult -

Returns:

whether or not the string representation of the given CDeleteSongResultEnum object equals our own