MartianManager

Object
- MartianManager

public class MartianManager
extends Object

This class is used to manage Martian objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<Martian>`	`martians` Stores subclass instances of `Martian`.
`protected ArrayList<Teleporter>`	`teleporters` Stores `Martian` instances that implement `Teleporter`.

Constructor Summary

Constructors
Constructor and Description

MartianManager()

Constructors
Constructor and Description
`MartianManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addMartian(Martian m)` Add a `m` to `martians` if a `Martian` doesn't already exist there with the same `id`.
`ArrayList<Martian>`	`battle(ArrayList<Martian> invaders)` This method accepts a list of `invaders`, which are `Martian`s.
`ArrayList<Martian>`	`battle2(ArrayList<Martian> invaders)` DO NOT WRITE THIS, It was for an alternate version of the battle method.
`boolean`	`contains(int id)` Returns `true` if `martians` contains a `Martians` with `id` and `false` otherwise.
`Martian`	`getMartianAt(int i)` Returns the `i`th Martian in `martians` or `null` if the index is invalid.
`Martian`	`getMartianClosestTo(int id)` Returns the Martian in `martians` that has an `id` closest to the `id` supplied; Note: �closest� doesn�t mean the next martian, For example, if you have martians with ids: 3, 4, 7, 8, 9 and you call the method with 5, then the martian with id=4 should be returned.
`Martian`	`getMartianClosestTo(Martian martian)` Returns the Martian in `martians` that is closest to `Martian` `martian` as measured by `id`.
`Martian`	`getMartianWithId(int id)` Returns the `Martian` with `id` or null if not found.
`int`	`getNumMartians()` Returns the number of Martains in `martians`.
`int`	`getNumTeleporters()` Returns the number of Teleporters in `teleporters`.
`private int`	`getPower(Martian m)` OPTIONAL METHOD - NOT REQUIRED, Returns the power for the input Martian.
`ArrayList<Martian>`	`getSortedMartians()` Returns a sorted list of `Martians` according to their `id`.
`Teleporter`	`getTeleporterAt(int i)` Returns the `i`th `Teleporter` in `teleporters` or `null` if the index is invalid.
`String`	`groupSpeak()` Returns the a string that contains the returns from each of the `martians` having their `speak` method called on it, with a line break after each one.
`String`	`groupTeleport(String dest)` Returns the a string that contains the returns from each `teleporters` having their `teleport` method called on it using the argument, `dest`, with a line break after each one.
`void`	`obliterateTeleporters()` Removes all `Teleporters` from `teleporters` and `martians`.
`Martian`	`removeMartian(int id)` Removes the `Martian` with `id` from `martians` and from `teleporters` if it is a `Teleporter`.
`String`	`toString()` Returns a list of all the `Martians` and `Teleporters` in this format:

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - martians
```
protected ArrayList<Martian> martians
```
    Stores subclass instances of Martian.
  - teleporters
```
protected ArrayList<Teleporter> teleporters
```
    Stores Martian instances that implement Teleporter.
- Constructor Detail
  - MartianManager
```
public MartianManager()
```
- Method Detail
  - addMartian
```
public boolean addMartian(Martian m)
```
    Add a m to martians if a Martian doesn't already exist there with the same id. Hint: use the contains or indexOf methods. If the Martian is also a Teleporter, it should be added to teleporters
    
    Parameters:
    
    m - The Martian to be added
    
    Returns:
    
    true if m was added to martians, otherwise false
  - battle
```
public ArrayList<Martian> battle(ArrayList<Martian> invaders)
```
    This method accepts a list of invaders, which are Martians. The method loops over the invaders. At each iteration, an invader "kills" the first Martian in martians that has less power that it does. It is possible that an invader does not kill a Martian, in which case we just continue to the next invader. For GreenMartians, power is simply the volume of a Martian. For RedMartians, power is volume+tenacity. Killed martians are returned in a list and removed from martians and teleporters (if applicable).
    
    Parameters:
    
    invaders - List of Martians who are invading the Martians in martians.
    
    Returns:
    
    ArrayList List of Martians who were killed and removed from martians
  - battle2
```
public ArrayList<Martian> battle2(ArrayList<Martian> invaders)
```
    DO NOT WRITE THIS, It was for an alternate version of the battle method.
    
    Parameters:
    
    invaders -
    
    Returns:
  - contains
```
public boolean contains(int id)
```
    Returns true if martians contains a Martians with id and false otherwise. Hint: use a dummy martian and the contains method, example is probably in most recent lab and in notes.
    
    Parameters:
    
    id -
    
    Returns:
    
    boolean
  - getMartianAt
```
public Martian getMartianAt(int i)
```
    Returns the ith Martian in martians or null if the index is invalid.
    
    Parameters:
    
    i -
    
    Returns:
  - getMartianClosestTo
```
public Martian getMartianClosestTo(int id)
```
    Returns the Martian in martians that has an id closest to the id supplied; Note: �closest� doesn�t mean the next martian, For example, if you have martians with ids: 3, 4, 7, 8, 9 and you call the method with 5, then the martian with id=4 should be returned. If you call the method with 7, then the martian with id=7 should be returned.
    
    Parameters:
    
    id -
    
    Returns:
  - getMartianClosestTo
```
public Martian getMartianClosestTo(Martian martian)
```
    Returns the Martian in martians that is closest to Martian martian as measured by id. Hint: this is a convenience method, it simply needs to call getMartianClosestTo(id:int)
    
    Parameters:
    
    martian -
    
    Returns:
  - getMartianWithId
```
public Martian getMartianWithId(int id)
```
    Returns the Martian with id or null if not found. Hint: use indexOf.
    
    Parameters:
    
    id -
    
    Returns:
  - getNumMartians
```
public int getNumMartians()
```
    Returns the number of Martains in martians.
    
    Returns:
    
    The number of Martains in martians.
  - getNumTeleporters
```
public int getNumTeleporters()
```
    Returns the number of Teleporters in teleporters.
    
    Returns:
    
    The number of Teleporters in teleporters.
  - getPower
```
private int getPower(Martian m)
```
    OPTIONAL METHOD - NOT REQUIRED, Returns the power for the input Martian. This is a helper method used by the battle method. I chose to write this method for my solution. You are not required to write this method. However, it makes sense to encapsulate this calculation.
    
    Parameters:
    
    m - Martian to return the power for.
    
    Returns:
    
    Power of Martian, see battle method.
  - getSortedMartians
```
public ArrayList<Martian> getSortedMartians()
```
    Returns a sorted list of Martians according to their id. This method should not alter the order of martians list instance variable. Hint: just create a new list of martians that contains the existing ones, sort it, and return.
    
    Returns:
    
    ArrayList
  - getTeleporterAt
```
public Teleporter getTeleporterAt(int i)
```
    Returns the ith Teleporter in teleporters or null if the index is invalid.
    
    Parameters:
    
    i -
    
    Returns:
  - groupSpeak
```
public String groupSpeak()
```
    Returns the a string that contains the returns from each of the martians having their speak method called on it, with a line break after each one.
    
    Returns:
  - groupTeleport
```
public String groupTeleport(String dest)
```
    Returns the a string that contains the returns from each teleporters having their teleport method called on it using the argument, dest, with a line break after each one.
    
    Parameters:
    
    dest - The destination that all teleporters teleport to.
    
    Returns:
  - obliterateTeleporters
```
public void obliterateTeleporters()
```
    Removes all Teleporters from teleporters and martians.
  - removeMartian
```
public Martian removeMartian(int id)
```
    Removes the Martian with id from martians and from teleporters if it is a Teleporter. If no martian is found, return null.
    
    Parameters:
    
    id -
    
    Returns:
    
    Martian
  - toString
```
public String toString()
```
    Returns a list of all the Martians and Teleporters in this format:
```
   Martians:
   Red Martian - id=1 vol=1, ten=1
   Red Martian - id=2 vol=2, ten=2
   Green Martian - id=3 vol=1
   Green Martian - id=4 vol=5
 
   Teleporters:
   Green Martian - id=3 vol=1
   Green Martian - id=4 vol=5
  
```
    Overrides:
    
    toString in class Object

Class MartianManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

martians

teleporters

Constructor Detail

MartianManager

Method Detail

addMartian

battle

battle2

contains

getMartianAt

getMartianClosestTo

getMartianClosestTo

getMartianWithId

getNumMartians

getNumTeleporters

getPower

getSortedMartians

getTeleporterAt

groupSpeak

groupTeleport

obliterateTeleporters

removeMartian

toString