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 Martians (either red or green) are compared based on their `id`’s which results in the usual ascending sorted order.
`boolean`	`equals(Object o)` Two Martians are equal if their `id`’s are equal, regardless of whether they are `GreenMartian`s or `RedMartians`s.
`int`	`getId()` Returns the `id` for the Martian.
`int`	`getVolume()` Returns the `volume` for the Martian.
`void`	`setVolume(int volume)` Set the `volume` for the Martian
`abstract String`	`speak()` Martian subclasses must implement this method to speak in the way that makes sense for them.
`String`	`toString()` OPTIONAL-NOT REQUIRED.

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)
```
    Two Martians are equal if their id’s are equal, regardless of whether they are GreenMartians or RedMartianss.
    
    Overrides:
    
    equals in class Object
  - getId
```
public int getId()
```
    Returns the id for the Martian.
    
    Returns:
    
    The id for the Martian.
  - getVolume
```
public int getVolume()
```
    Returns the volume for the Martian.
    
    Returns:
    
    The volume for the Martian.
  - setVolume
```
public void setVolume(int volume)
```
    Set the volume for the Martian
    
    Parameters:
    
    volume -
  - speak
```
public abstract String speak()
```
    Martian subclasses must implement this method to speak in the way that makes sense for them.
    
    Returns:
    
    The string that represents the Martian speaking.
  - toString
```
public String toString()
```
    OPTIONAL-NOT REQUIRED. I implemented this to return a string like:
```
   id=xxx, vol=yyy
  
```
    where xxx is the id, yyy is the volume. Then, RedMartian and GreenMartian toString can call this.
    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

setVolume

speak

toString