Martian

Object
- Martian

All Implemented Interfaces:

Comparable<Martian>

Direct Known Subclasses:

GreenMartian, RedMartian
```
public abstract class Martian
extends Object
implements Comparable<Martian>
```
This abstract class models a Martian.

Field Summary

Fields
Modifier and Type Field and Description

private int id
Every Martian has an id which is simply an integer.

private int volume
Every Martian has a volume which is simply an integer.

Fields
Modifier and Type	Field and Description
`private int`	`id` Every `Martian` has an id which is simply an integer.
`private int`	`volume` Every `Martian` has a volume which is simply an integer.

Constructor Summary

Constructors
Constructor and Description

Martian(int id, int volume)
Creates a Martian with the specified id and volume.

Constructors
Constructor and Description
`Martian(int id, int volume)` Creates a `Martian` with the specified `id` and `volume`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Martian m)` Implements Java's `compareTo` so that `Martian`s (either red or green) are compared based on their `id`'s which results in the usual ascending sorted order.
`boolean`	`equals(Object o)` Returns `true` if the input is a `Martian` whose `id` is the same is this `Martian`'s `id`.
`int`	`getId()` Returns the `id` for this `Martian`.
`int`	`getVolume()` Returns the `volume` for this `Martian`.
`abstract int`	`power()` Returns the power of this `Martian`.
`void`	`setVolume(int volume)` Set the `volume` for this `Martian`.
`abstract String`	`speak()` Returns a string that represents this `Martian` speaking.
`String`	`toString()` Returns a string in this exact format:

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

- Field Detail
  - id
```
private int id
```
    Every Martian has an id which is simply an integer.
  - volume
```
private int volume
```
    Every Martian has a volume which is simply an integer.
- Constructor Detail
  - Martian
```
public Martian(int id,
               int volume)
```
    Creates a Martian with the specified id and volume.
    
    Parameters:
    
    id -
    
    volume -
- Method Detail
  - compareTo
```
public int compareTo(Martian m)
```
    Implements Java's compareTo so that Martians (either red or green) are compared based on their id's which results in the usual ascending sorted order.
    
    Specified by:
    
    compareTo in interface Comparable<Martian>
  - equals
```
public boolean equals(Object o)
```
    Returns true if the input is a Martian whose id is the same is this Martian's id.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - The object being compared to this object.
    
    Returns:
    
    true if this Martian's id is the same as the input's id.
  - getId
```
public int getId()
```
    Returns the id for this Martian.
    
    Returns:
    
    The id for this Martian.
  - getVolume
```
public int getVolume()
```
    Returns the volume for this Martian.
    
    Returns:
    
    The volume for this Martian.
  - power
```
public abstract int power()
```
    Returns the power of this Martian.
    
    Returns:
    
    The power of this Martian.
  - setVolume
```
public void setVolume(int volume)
```
    Set the volume for this Martian.
    
    Parameters:
    
    volume - The new volume
  - speak
```
public abstract String speak()
```
    Returns a string that represents this Martian speaking.
    
    Returns:
    
    The string that represents this Martian speaking.
  - toString
```
public String toString()
```
    Returns a string in this exact format:
```
   id=X, vol=Y
```
    where X is the id, Y is the volume. Note that RedMartian and GreenMartian's toString can use these values by calling: super.toString().
    Overrides:
    
    toString in class Object

Class Martian

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

id

volume

Constructor Detail

Martian

Method Detail

compareTo

equals

getId

getVolume

power

setVolume

speak

toString