Package edu.ie3.datamodel.models.input.container

Record Class ThermalUnits

java.lang.Object

java.lang.Record

edu.ie3.datamodel.models.input.container.ThermalUnits

Record Components:

houses - Available houses

storages - Available storage

All Implemented Interfaces:

InputContainer<ThermalUnitInput>, Serializable

public record ThermalUnits(Set<ThermalHouseInput> houses, Set<ThermalStorageInput> storages)
extends Record
implements InputContainer<ThermalUnitInput>

Container to group together all ThermalUnitInputs

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ThermalUnits(Collection<ThermalHouseInput> houses, Collection<ThermalStorageInput> storages)
ThermalUnits(Set<ThermalHouseInput> houses, Set<ThermalStorageInput> storages)	Creates an instance of a ThermalUnits record class.

Method Summary

Modifier and Type	Method	Description
List<ThermalUnitInput>	allEntitiesAsList()
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.
Set<ThermalHouseInput>	houses()	Returns the value of the houses record component.
Set<ThermalStorageInput>	storages()	Returns the value of the storages record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ThermalUnits

public ThermalUnits(Collection<ThermalHouseInput> houses,
 Collection<ThermalStorageInput> storages)

ThermalUnits

public ThermalUnits(Set<ThermalHouseInput> houses,
 Set<ThermalStorageInput> storages)

Creates an instance of a ThermalUnits record class.

Parameters:

houses - the value for the houses record component

storages - the value for the storages record component

Method Details

allEntitiesAsList

public List<ThermalUnitInput> allEntitiesAsList()

Specified by:

allEntitiesAsList in interface InputContainer<ThermalUnitInput>

Returns:

unmodifiable List of all entities

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.

houses

public Set<ThermalHouseInput> houses()

Returns the value of the houses record component.

Returns:

the value of the houses record component

storages

public Set<ThermalStorageInput> storages()

Returns the value of the storages record component.

Returns:

the value of the storages record component