Package a03

Class Cabin

java.lang.Object

a03.Cabin

public class Cabin
extends java.lang.Object

A class to represent a cabin at a resort. Cabins are given names, and have a fixed number of bedrooms. The rent for a Cabin depends on how many rooms it has and how many people are staying in it. Cabins usually hold two people per bedroom, but may hold up to three people per bedroom (at an extra charge).

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_PEOPLE_PER_ROOM
java.lang.String	name	The name for this Cabin.
int	numRooms	The number of bedrooms this Cabin has.
static int	USUAL_PEOPLE_PER_ROOM

Constructor Summary

Constructors

Constructor	Description
Cabin(java.lang.String name, int numRooms)	Create a Cabin with the given name and number of bedrooms.

Method Summary

Modifier and Type	Method	Description
double	getBasicRent()	The basic rent for this Cabin, based on number of rooms.
double	getCurrentRent()	Calculate how much rent this room is bringing in.
int	getMaxOccupancy()	Get the maximum capacity of this Cabin.
java.lang.String	getName()	Get the name of this Cabin.
int	getNumOccupants()	Get the current number of occupants.
int	getNumRooms()	Get the number of bedrooms in this Cabin.
double	getSurcharge()	The surcharge for this Cabin, based on the number of people in it.
boolean	isOccupied()	Return whether this room is occupied.
void	removeOccupants()	Mark this room as open for rental.
static void	setBaseRate(double rate)	Set the basic rental rate for all Cabins.
static void	setExtraPersonRate(double rate)	Set the surcharge for each extra person in the Cabin.
static void	setExtraRoomRate(double rate)	Set the amount the rate rises for every bedroom after the first.
void	setOccupants(int numOccupants)	Rent this Cabin to a group of the given size.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PEOPLE_PER_ROOM

public static final int MAX_PEOPLE_PER_ROOM

See Also:

Constant Field Values

USUAL_PEOPLE_PER_ROOM

public static final int USUAL_PEOPLE_PER_ROOM

See Also:

Constant Field Values

name

public final java.lang.String name

The name for this Cabin.

numRooms

public final int numRooms

The number of bedrooms this Cabin has.

Constructor Detail

Cabin

public Cabin(java.lang.String name,
             int numRooms)

Create a Cabin with the given name and number of bedrooms. The number of rooms must be positive (at least one).

Parameters:

name - the name of this Cabin

numRooms - the number of bedrooms for this Cabin

Throws:

java.lang.IllegalArgumentException - if the number of rooms is less than one

Method Detail

getName

public java.lang.String getName()

Get the name of this Cabin.

Returns:

the name of this Cabin

getNumRooms

public int getNumRooms()

Get the number of bedrooms in this Cabin.

Returns:

the number of bedrooms in this Cabin

getNumOccupants

public int getNumOccupants()

Get the current number of occupants.

Returns:

the number of people registered in this Cabin

getCurrentRent

public double getCurrentRent()

Calculate how much rent this room is bringing in. If the room is unoccupied, then it's not bringing in any rent at all. Otherwise, it's bringing in the basic rent plus any surcharge for extra people.

Returns:

0.00 if the room is unoccupied; basic rent plus surcharge (if any) for occupied cabins

getBasicRent

public double getBasicRent()

The basic rent for this Cabin, based on number of rooms. This is the amount the Cabin rents for when there are no extra people in it.

Returns:

the basic rate for renting this room

getSurcharge

public double getSurcharge()

The surcharge for this Cabin, based on the number of people in it. The surcharge is the extraPersonRate times the number of people over the usual occupancy for this Cabin.

Returns:

how much extra is charged for having extra people in the Cabin

isOccupied

public boolean isOccupied()

Return whether this room is occupied.

Returns:

true if the number of occupants in this room is positive

setOccupants

public void setOccupants(int numOccupants)

Rent this Cabin to a group of the given size.

Parameters:

numOccupants - the number of people to register in this Cabin

Throws:

java.lang.IllegalArgumentException - if the number of occupants is less than one or more than the maximum occupancy for this Cabin.

removeOccupants

public void removeOccupants()

Mark this room as open for rental.

getMaxOccupancy

public int getMaxOccupancy()

Get the maximum capacity of this Cabin. The maximum capacity of each bedroom is specified by MAX_PEOPLE_PER_ROOM. Thus the maximum occupancy of a Cabin is that many people times the number of rooms in this Cabin.

Returns:

the maximum number of people who may stay in this Cabin at one time

setBaseRate

public static void setBaseRate(double rate)

Set the basic rental rate for all Cabins. This is the rental rate for a one-room Cabin before surcharges. The actual rent for any Cabin depends on how many rooms it has and how many people are staying in it.

Parameters:

rate - the rental rate for a basic Cabin

setExtraRoomRate

public static void setExtraRoomRate(double rate)

Set the amount the rate rises for every bedroom after the first. A one-room Cabin charges the baseRate. This is how much extra the basic rent is for each extra bedroom in the Cabin.

Parameters:

rate - how much extra each bedroom is in rent

setExtraPersonRate

public static void setExtraPersonRate(double rate)

Set the surcharge for each extra person in the Cabin. Cabins normally hold up to two people per bedroom (see USUAL_PEOPLE_PER_ROOM). Each person beyond that number is charged this amount.

Parameters:

rate - how much extra each person raises the rent