java experts

This class comprises a component of a larger game. You have been asked to implement the structure that maintains a group of items contained within a backpack. Your task is to produce the central class that will reflect the inventory of a container in the game. You do not need to write any code but inside the Inventory.java file. You cannot change the method signatures or the class name. You simply need to fill in the details for each method in the Inventory.java class. You will be provided with the skeleton of the code as a starting point.

Data Structure

To make your life easier you will be provided with this API specification (just like the JavaDocs you use for your programming). You have a set of requirements

· You must use an Item array to store your Items in your Class.

· You are not permitted to use any collection Classes in this assignment.

· You must implement the entire class based on the API specification. This class will encapsulate all the functionality required.

· Each method javadoc will contain a list of the permissible method calls you must use only these method calls.

I have also left an indication of the length of a solution. Your solution could be shorter or longer its just an indication so that you can get an idea of how long "a" solution was. My calculation was done by counting every line (including close braces). All if/while/for loops had braces except error checking lines which had the return statement on the same line as the check. Eg if(x==false) return null; Comment lines also were not counted.

Testing

A test program (using junit, InventoryTest) is also provided for you to use. Please read it carefully. Use the test driver as a starting point to test your Class as thoroughly as possible. Note that the marker reserves the right to test more conditions if they think of them.

Note crafting your code to produce what the testing mechanism is expecting will get you a fail in the assignment. For example writing methods to just return fixed values.

I suggest you do your assignment in the following order

· Create all the method signatures in the Inventory Class. Each method should just be blank (with a return null, false or -1 if necessary).

· Compile and make sure that the program works (well, technically it won't because the methods are empty, but make sure it compiles with no errors).

· Write the addGold method. Test.

· Write the removeGold method. Test.

· Write the getGold method. Test.

· Write the increaseArray method. Test.

· Write the addItem method. Test.

· Write the numberOfItems method. Test.

· Write the decreaseArray method. Test.

· Write the indexOf method. Test.

· Write the removeItem -int- method. Test.

· Write the removeItem -String- method. Test.

· Write the itemAt method. Test.

· Write the buyItem method. Test.

· Write the getNumberOfItem method. Test.

· Write the indexOf method. Test.

· Write the rest of the methods. Test.

Note that when you add functionality you may have to add test scenarios to other test methods to ensure you have covered all the possibilities.

Additional Requirement.

In addition to what is above there are a number of requirements for this assignment. Most of these are to introduce interesting problems for you to solve and must be obeyed.

· As you are programming you will also need to comment your code thoroughly in each of your methods.

· You are only permitted to use the the specified methods in the java doc comments for each method.

· The item array in your structure must always have only the space that is required.

· You may create additional methods (private only) but they are still constrained by the rules of the calling method

· You must not change the package name, class names, method names or the attributes of any of the classes.

·

· Field Summary

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

·

public static java.lang.String studentEmailID

Fill this id in so the marking system looks pretty (and you get marks)

private int goldCoins

The number of coins in the inventory

double maximumCarryingCapacity

Maximum carrying capacity

int maximumNumberOfItems

Maximum number of items;

java.lang.String name

Name of inventory

public static java.lang.String encoodeID

Don't mess with this value

public Inventory()

private void increaseArray()

Increase the array by one. You will need to create a new array one element bigger than the old array. No External Classes Permitted to Be Used in This Method

My Solution Length in Lines (note yours can be longer or shorter): 4

private boolean decreaseArray()

shrink the array by one. You will need to create a new array one smaller than the current one then copy the old one into the new one. This method should fail if the list is less than 1 in size, also if the last element is not null. No External Classes Permitted to Be Used in This Method

My Solution Length in Lines (note yours can be longer or shorter): 9

Returns:

true if it was successful false if unsuccessful

public void addGold(int amountToAdd)

Add gold to the inventory.

My Solution Length in Lines (note yours can be longer or shorter): 1

Parameters:

amountToAdd - add the gold to the inventory

public int removeGold(int amountToRemove)

remove gold from inventory. If you ask for more than you got in the inventory return -1 to flag that its not possible to remove gold else remove the gold and return the amount you removed from the inventory.

My Solution Length in Lines (note yours can be longer or shorter): 6

Parameters:

amountToRemove - The amount of gold to remove from the inventory

Returns:

the amount removed unless it would have gone negative then -1

public int getGold()

Returns the current gold coins in the inventory Not tested in Junit

My Solution Length in Lines (note yours can be longer or shorter): 1

Returns:

amount of gold in kitty

· public boolean damageItem(int index,

double damage)

Damage the particular item at the index. If the item is destroyed (eg damage greater than the durability of the item. The item should be left in the list with status updated to broken. No External Classes Permitted to Be Used in This Method Apart from String.equals.

My Solution Length in Lines (note yours can be longer or shorter): 3

Parameters:

index - the item to damage

damage - the amount of damage

Returns:

true if the item was broken false if not found or not broken

public boolean repairItem(java.lang.String nameToBeRepaired)

Repair the item of the name. The item will be repaired only if there is enough gold in the inventory to pay for it. The cost of the repair is 25% of the lost value of the durability For example If you had a widget that was worth 1000 gold coins and it was at 60% durability then its current value is 600 gold coins. It has lost 400 gold coins in value due to wear. If you repair the item it will cost 100 gold coins (25% of 400 gold coins). If there is not enough gold to repair the item it should not repair the item at all and return false. Otherwise it should remove the gold coins from the inventory and return true.

My Solution Length in Lines (note yours can be longer or shorter): 3

Parameters:

nameToBeRepaired - the name of the item to be repaired

Returns:

true if successfully repaired false otherwise

public boolean repairItem(int index)

Repair the item at the index. The item will be repaired only if there is enough gold in the inventory to pay for it. The cost of the repair is 25% of the lost value of the durability For example If you had a widget that was worth 1000 gold coins and it was at 60% durability then its current value is 600 gold coins. It has lost 400 gold coins in value due to wear. If you repair the item it will cost 100 gold coins (25% of 400 gold coins). If there is not enough gold to repair the item it should not repair the item at all and return false. Otherwise it should remove the gold coins from the inventory and return true.

My Solution Length in Lines (note yours can be longer or shorter): 6

Parameters:

index - of the item to be repaired

Returns:

true if successfully repaired false otherwise

public int numberOfItems()

Return the number of items in the list. No External Classes Permitted to Be Used in This Method

My Solution Length in Lines (note yours can be longer or shorter): 1

Returns:

the number of items

public int indexOf(java.lang.String nameToBeFound)

return the index of the item with the given name. Case does not matter. No External Classes Permitted to Be Used in This Method Apart from String.Equals and String.ToUpperCase

My Solution Length in Lines (note yours can be longer or shorter): 6

Parameters:

nameToBeFound - the name of the item to be found

Returns:

the position of the searched for item. -1 if none found

public void sort()

ADVANCED STUDENTS ONLY Sort the array by item name. Note that if you are not attempting this method you must still implement the method signature so that the test program will run. No External Classes Permitted to Be Used in This Method Apart From String.CompareToIgnoreCase

My Solution Length in Lines (note yours can be longer or shorter): 12

public java.lang.String toString()

Creates a list of item with their hit points in the following form Item List 1. output of item toStringMethod 2. output of item toStringMethod 3. output of item toStringMethod 4. output of item toStringMethod Note the formatting is done so that the output lines up in the columns Please use the most appropriate classes to help you do this method.

My Solution Length in Lines (note yours can be longer or shorter): 5

Overrides:

toString in class java.lang.Object

private void dumpAll()

Debug function for testing that things are working ok. Dumps a printout of the current state of the item array