org.jscience.geography
Class Home

java.lang.Object
  org.jscience.geography.Place
      org.jscience.geography.OwnedPlace
          org.jscience.geography.Home

All Implemented Interfaces:

Property, Named, Positioned

public class Home
extends OwnedPlace
implements Property

A class representing a geographical a human home.

Constructor Summary

Home(java.lang.String name, Boundary boundary, Address address, java.util.Set owners, java.util.Set occupants)
Creates a new Home object.

Method Summary

void	addOccupant(Individual occupant) DOCUMENT ME!
void	addOwner(Human owner) DOCUMENT ME!
Address	getAddress() DOCUMENT ME!
java.util.Set	getOccupants() DOCUMENT ME!
java.util.Set	getOwners() DOCUMENT ME!
Amount<Money>	getValue() DOCUMENT ME!
void	removeOccupant(Individual occupant) DOCUMENT ME!
void	removeOwner(Human owner) DOCUMENT ME!
void	setAddress(Address address) DOCUMENT ME!
void	setOccupants(java.util.Set occupants) DOCUMENT ME!
void	setOwners(java.util.Set owners) DOCUMENT ME!
void	setValue(Amount<Money> value) DOCUMENT ME!

Methods inherited from class org.jscience.geography.Place

getBoundary, getName, getPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

Home

public Home(java.lang.String name,
            Boundary boundary,
            Address address,
            java.util.Set owners,
            java.util.Set occupants)

Creates a new Home object.

Parameters:

name - DOCUMENT ME!

boundary - DOCUMENT ME!

address - DOCUMENT ME!

owners - DOCUMENT ME!

occupants - DOCUMENT ME!

Method Detail

getAddress

public Address getAddress()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setAddress

public void setAddress(Address address)

DOCUMENT ME!

Parameters:

address - DOCUMENT ME!

getOwners

public java.util.Set getOwners()

DOCUMENT ME!

Specified by:

getOwners in interface Property

Overrides:

getOwners in class OwnedPlace

Returns:

DOCUMENT ME!

addOwner

public void addOwner(Human owner)

DOCUMENT ME!

Overrides:

addOwner in class OwnedPlace

Parameters:

owner - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

removeOwner

public void removeOwner(Human owner)

DOCUMENT ME!

Overrides:

removeOwner in class OwnedPlace

Parameters:

owner - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

setOwners

public void setOwners(java.util.Set owners)

DOCUMENT ME!

Overrides:

setOwners in class OwnedPlace

Parameters:

owners - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

getOccupants

public java.util.Set getOccupants()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addOccupant

public void addOccupant(Individual occupant)

DOCUMENT ME!

Parameters:

occupant - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

removeOccupant

public void removeOccupant(Individual occupant)

DOCUMENT ME!

Parameters:

occupant - DOCUMENT ME!

setOccupants

public void setOccupants(java.util.Set occupants)

DOCUMENT ME!

Parameters:

occupants - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!

getValue

public Amount<Money> getValue()

DOCUMENT ME!

Specified by:

getValue in interface Property

Overrides:

getValue in class OwnedPlace

Returns:

DOCUMENT ME!

setValue

public void setValue(Amount<Money> value)

DOCUMENT ME!

Overrides:

setValue in class OwnedPlace

Parameters:

value - DOCUMENT ME!

Throws:

java.lang.IllegalArgumentException - DOCUMENT ME!