Record Class ClimateZone

java.lang.Object

java.lang.Record

org.episteme.social.geography.ClimateZone

All Implemented Interfaces:

Serializable

public record ClimateZone(ClimateZone.Type type, Quantity<Temperature> averageTemp, Quantity<Length> annualRainfall)
extends Record
implements Serializable

Represents a simplified Köppen climate classification and associated metrics.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClimateZone.Type

Constructor Summary

Constructors

Constructor	Description
ClimateZone(ClimateZone.Type type, Real averageTemp, Real annualRainfall)	Legacy constructor for simple values.
ClimateZone(ClimateZone.Type type, Quantity<Temperature> averageTemp, Quantity<Length> annualRainfall)	Creates an instance of a ClimateZone record class.

Method Summary

Modifier and Type	Method	Description
Quantity<Length>	annualRainfall()	Returns the value of the annualRainfall record component.
Quantity<Temperature>	averageTemp()	Returns the value of the averageTemp record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isHabitable()	Checks if the climate supports permanent human settlement.
boolean	supportsAgriculture()	Checks if the climate supports outdoor agriculture.
String	toString()	Returns a string representation of this record class.
ClimateZone.Type	type()	Returns the value of the type record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClimateZone

public ClimateZone(ClimateZone.Type type,
 Real averageTemp,
 Real annualRainfall)

Legacy constructor for simple values.

ClimateZone

public ClimateZone(ClimateZone.Type type,
 Quantity<Temperature> averageTemp,
 Quantity<Length> annualRainfall)

Creates an instance of a ClimateZone record class.

Parameters:

type - the value for the type record component

averageTemp - the value for the averageTemp record component

annualRainfall - the value for the annualRainfall record component

Method Details

isHabitable

public boolean isHabitable()

Checks if the climate supports permanent human settlement.

supportsAgriculture

public boolean supportsAgriculture()

Checks if the climate supports outdoor agriculture.

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public ClimateZone.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

averageTemp

public Quantity<Temperature> averageTemp()

Returns the value of the averageTemp record component.

Returns:

the value of the averageTemp record component

annualRainfall

public Quantity<Length> annualRainfall()

Returns the value of the annualRainfall record component.

Returns:

the value of the annualRainfall record component