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
`void`	`absorbColony(ArrayList<Martian> colony)` Add the `Martian`s in `colony` to this `MartianManager`
`boolean`	`addMartian(Martian m)` Adds `m` to `martians` provide that a `Martian` doesn't already exist there with the same `id`.
`private double`	`averagePower()` OPTIONAL - Helper method to calculate the average power.
`ArrayList<Martian>`	`battle(ArrayList<Martian> invaders)` This method accepts a list of `invaders`, which battle with the `martains` resulting in some `Martian`s being removed from `martians` and returned in a list.
`ArrayList<Martian>`	`battle2(ArrayList<Martian> invaders)` DO NOT WRITE THIS METHOD - It was for an alternate version of the battle method.
`ArrayList<Martian>`	`captureInvaders(ArrayList<Martian> invaders)` Adds all `invader`s to this `MartianManager` that have `power` greater than the average power of all `Martian`s in this `MartianManager`.
`boolean`	`contains(int id)` Returns `true` if `martians` contains a `Martian` 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 input `id`.
`Martian`	`getMartianClosestTo(Martian martian)` Returns the Martian in `martians` that has an `id` closest to the input `Martian`'s `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`.
`ArrayList<Martian>`	`getSortedMartians()` Returns a list of `Martian`s sorted 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 a string representing all the `martians` speaking.
`String`	`groupTeleport(String dest)` Returns a string representing all the `teleporters` teleporting to `dest`.
`void`	`obliterateTeleporters()` Removes all `Teleporter`s from `teleporters` and `martians`.
`Martian`	`removeMartianAt(int loc)` Removes the `Martian` at index `loc` from `martians` and returns it.
`Martian`	`removeMartianWithId(int id)` Removes the `Martian` with `id` from `martians` and returns it.
`String`	`toString()` Returns a list of all the `Martians` and `Teleporters` in this exact 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
  - absorbColony
```
public void absorbColony(ArrayList<Martian> colony)
```
    Add the Martians in colony to this MartianManager
    
    Parameters:
    
    colony - List of Martians to be added to this MartianManager
  - addMartian
```
public boolean addMartian(Martian m)
```
    Adds m to martians provide that 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 also be added to teleporters
    
    Parameters:
    
    m - The Martian to be added
    
    Returns:
    
    true if m was added to martians; otherwise, false
  - averagePower
```
private double averagePower()
```
    OPTIONAL - Helper method to calculate the average power.
    
    Returns:
  - battle
```
public ArrayList<Martian> battle(ArrayList<Martian> invaders)
```
    This method accepts a list of invaders, which battle with the martains resulting in some Martians being removed from martians and returned in a list. The method loops over the invaders. At each iteration, an invader "kills" the first Martian in martians that has less power than it does and then moves on to the next invader. It is possible that an invader does not kill a Martian, in which case move on to the next invader. 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:
    
    List of Martians who were killed and removed from martians and teleporters (if applicable).
  - battle2
```
public ArrayList<Martian> battle2(ArrayList<Martian> invaders)
```
    DO NOT WRITE THIS METHOD - It was for an alternate version of the battle method.
    
    Parameters:
    
    invaders -
    
    Returns:
  - captureInvaders
```
public ArrayList<Martian> captureInvaders(ArrayList<Martian> invaders)
```
    Adds all invaders to this MartianManager that have power greater than the average power of all Martians in this MartianManager. The average power is computed once, before the invasion occurs, i.e. before any invaders have been added. This method should also return a list of all invaders that were added to this MartianManager.
    
    Parameters:
    
    invaders - Martians that may be added to this MartianManager
    
    Returns:
    
    The invaders that were added to this MartianManager.
  - contains
```
public boolean contains(int id)
```
    Returns true if martians contains a Martian 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:
  - 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 input id. For example, if martians contains Martian objects with ids: 3, 5, 8, 9; then:
```
   getMartianClosestTo(6) returns the Martain with id=5
   getMartianClosestTo(7) returns the Martain with id=8
```
    Parameters:
    
    id - Find the closest Martian to this id.
    
    Returns:
    
    The Martian in martians that is closest to the input id
  - getMartianClosestTo
```
public Martian getMartianClosestTo(Martian martian)
```
    Returns the Martian in martians that has an id closest to the input Martian's 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.
  - getSortedMartians
```
public ArrayList<Martian> getSortedMartians()
```
    Returns a list of Martians sorted 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:
    
    List of sorted Martians.
  - 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 a string representing all the martians speaking. In other words, 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 a string representing all the teleporters teleporting to dest. In other words, a string that contains the returns from each of the 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.
  - removeMartianAt
```
public Martian removeMartianAt(int loc)
```
    Removes the Martian at index loc from martians and returns it. If it is a Teleporter then it should be removed fromteleporters also. If loc is invalid, then null should be returned.
    
    Parameters:
    
    loc - The index in martians of the Martian to remove.
    
    Returns:
    
    The removed Martian
  - removeMartianWithId
```
public Martian removeMartianWithId(int id)
```
    Removes the Martian with id from martians and returns it. If it is a Teleporter then it should also be removed from teleporters. If no Martian exists in martians with id then return null
    
    Parameters:
    
    id - The id of the Martian to remove.
    
    Returns:
    
    The removed Martian
  - toString
```
public String toString()
```
    Returns a list of all the Martians and Teleporters in this exact 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

absorbColony

addMartian

averagePower

battle

battle2

captureInvaders

contains

getMartianAt

getMartianClosestTo

getMartianClosestTo

getMartianWithId

getNumMartians

getNumTeleporters

getSortedMartians

getTeleporterAt

groupSpeak

groupTeleport

obliterateTeleporters

removeMartianAt

removeMartianWithId

toString