org.starhope.appius.game
Class MusicItem

java.lang.Object
  org.starhope.appius.sql.SQLPeerDatum
      org.starhope.appius.game.InventoryItem
          org.starhope.appius.game.MusicItem

All Implemented Interfaces:

Serializable

public class MusicItem
extends InventoryItem

This represents a song that the player can play in his/her MP3 Player controls in the user interface.

Author:

brpocock

See Also:

Serialized Form

Field Summary

private String	filename The MP3 filename to be played
private static long	serialVersionUID Java serialization unique ID serialVersionUID (long)
private String	title The user-visible title field

Fields inherited from class org.starhope.appius.game.InventoryItem

active, CLOTHES, FURNITURE, GAME_EQUIP_ITEM, id, MUSIC, ownerID, PATTERNS, PIVITZ, slotNumber, STATIONERY, STRUCTURE, T_Backpacks, T_Ceiling, T_Ceiling_Furniture, T_Dresses, T_Ears, T_Eyes, T_Floor_Furniture, T_Flooring, T_Game_Equip_Item, T_Music, T_Neck, T_Orbitz, T_Pants, T_Pattern, T_Pet, T_Pivitz, T_Shirts, T_Stationery, T_TootBook_Avatar_BG, T_TootBook_Box_Style, T_TootBook_Icon, T_TootBook_Page_BG, T_TootBook_Title_BG, T_TootBookTheme, T_Tops, T_Vehicle, T_Wall_Furniture, T_Wallpaper, TB_AVATAR_BG, TB_BOX_STYLES, TB_ICON, TB_PAGE_BG, TB_TITLE_BG, type, Type_Backpacks, Type_Ceiling, Type_Ceiling_Furniture, Type_Dresses, Type_Ears, Type_Eyes, Type_Floor_Furniture, Type_Flooring, Type_Music, Type_Neck, Type_Orbitz, Type_Pants, Type_Pattern, Type_Pivitz, Type_Shirts, Type_Tops, Type_Wall_Furniture, Type_Wallpaper

Fields inherited from class org.starhope.appius.sql.SQLPeerDatum

hackyDatabaseConnection

Constructor Summary

MusicItem()

Method Summary

protected void	assertValidType(InventoryItemType t) TODO: document this method (brpocock, Nov 19, 2009)
protected void	assertValidTypeID(long testTypeID) This is an overriding method.
String	getFilename()
String	getTitle()
protected void	set(ResultSet rs) This is an overriding method.
void	setFilename(String filename1)
protected void	setFromInventory(ResultSet inv) This is an overriding method.
void	setTitle(String title1)
org.json.JSONObject	toJSON() This is an overriding method.

Methods inherited from class org.starhope.appius.game.InventoryItem

asClothing, asHomeDecorItem, equals, equip, flush, getByID, getByID, getCacheUniqueID, getClassForThisType, getClassForType, getClassForType, getFromInventory, getID, getItemClass, getMountPoint, getOwner, getOwnerID, getSlotNumber, getType, getTypeID, getTypesOfClothingT, getTypesOfFurnitureT, getTypesOfHomeDecorT, getTypesOfStructureT, getTypesOfWearablesT, hasANomen, hashCode, identifiesAs, isActive, isAPet, isClothingOnly, isFurniture, isMusic, isPattern, isPet, isPivitz, isStructure, isVehicle, isWearable, pullFromInventory, setActive, setOwner, setOwnerID, setSlotHarsh, setSlotNumber, setType, setTypeID, toString, unequip

Methods inherited from class org.starhope.appius.sql.SQLPeerDatum

changed, findInCache, get, prepareX, prepareX, saveInCache, set

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Java serialization unique ID serialVersionUID (long)

See Also:

Constant Field Values

filename

private String filename

The MP3 filename to be played

title

private String title

The user-visible title field

Constructor Detail

MusicItem

public MusicItem()

Method Detail

assertValidType

protected void assertValidType(InventoryItemType t)
                        throws GameLogicException

Description copied from class: InventoryItem

TODO: document this method (brpocock, Nov 19, 2009)

Specified by:

assertValidType in class InventoryItem

Parameters:

t - WRITEME

Throws:

GameLogicException - WRITEME

See Also:

InventoryItem.assertValidType(org.starhope.appius.types.InventoryItemType)

assertValidTypeID

protected void assertValidTypeID(long testTypeID)
                          throws GameLogicException

This is an overriding method.

Overrides:

assertValidTypeID in class InventoryItem

Parameters:

testTypeID - The type ID to be checked

Throws:

GameLogicException - if the type ID is not of the types supported by this class

See Also:

InventoryItem.assertValidTypeID(long)

getFilename

public String getFilename()

Returns:

the filename

getTitle

public String getTitle()

Returns:

the title

set

protected void set(ResultSet rs)
            throws SQLException

This is an overriding method.

Specified by:

set in class SQLPeerDatum

Parameters:

rs - The result of an SQL query, with the cursor already pointed at the row describing this specific instance of the object.

Throws:

SQLException - if the database fails somehow

See Also:

SQLPeerDatum.set(java.sql.ResultSet)

setFilename

public void setFilename(String filename1)

Parameters:

filename1 - the new MP3 filename for this song

setFromInventory

protected void setFromInventory(ResultSet inv)
                         throws SQLException

This is an overriding method.

Specified by:

setFromInventory in class InventoryItem

Parameters:

inv - WRITEME

Throws:

SQLException - WRITEME

See Also:

InventoryItem.setFromInventory(java.sql.ResultSet)

setTitle

public void setTitle(String title1)

Parameters:

title1 - the new title for this song

toJSON

public org.json.JSONObject toJSON()

This is an overriding method.

Overrides:

toJSON in class InventoryItem

Returns:

This object's data, serialized into JSON form.

See Also:

InventoryItem.toJSON()