Package energy.eddie.dataneeds.rules

Record Class DataNeedRule.ValidatedHistoricalDataDataNeedRule

java.lang.Object

java.lang.Record

energy.eddie.dataneeds.rules.DataNeedRule.ValidatedHistoricalDataDataNeedRule

Record Components:

energyType - the supported EnergyType.

granularities - a list of supported Granularity.

All Implemented Interfaces:

DataNeedRule, DataNeedRule.SpecificDataNeedRule<ValidatedHistoricalDataDataNeed>

Enclosing interface:

DataNeedRule

public static record DataNeedRule.ValidatedHistoricalDataDataNeedRule(EnergyType energyType, List<Granularity> granularities)
extends Record
implements DataNeedRule.SpecificDataNeedRule<ValidatedHistoricalDataDataNeed>

The ValidatedHistoricalDataDataNeedRule specifies one supported variant of the ValidatedHistoricalDataDataNeed.

Nested Class Summary

Nested classes/interfaces inherited from interface energy.eddie.dataneeds.rules.DataNeedRule

DataNeedRule.AccountingPointDataNeedRule, DataNeedRule.AllowMultipleDataNeedsRule, DataNeedRule.InboundAiidaDataNeedRule, DataNeedRule.OutboundAiidaDataNeedRule, DataNeedRule.SpecificDataNeedRule<T extends DataNeed>, DataNeedRule.ValidatedHistoricalDataDataNeedRule

Constructor Summary

Constructors

Constructor	Description
ValidatedHistoricalDataDataNeedRule(EnergyType energyType, List<Granularity> granularities)	Creates an instance of a ValidatedHistoricalDataDataNeedRule record class.

Method Summary

Modifier and Type	Method	Description
EnergyType	energyType()	Returns the value of the energyType record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Class<ValidatedHistoricalDataDataNeed>	getDataNeedClass()	Returns the type of data need that is supported by this rule.
String	getType()	This method indicates the type of the DataNeed.
List<Granularity>	granularities()	Returns the value of the granularities record component.
final int	hashCode()	Returns a hash code value for this object.
final 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

ValidatedHistoricalDataDataNeedRule

public ValidatedHistoricalDataDataNeedRule(EnergyType energyType,
 List<Granularity> granularities)

Creates an instance of a ValidatedHistoricalDataDataNeedRule record class.

Parameters:

energyType - the value for the energyType record component

granularities - the value for the granularities record component

Method Details

getType

public String getType()

Description copied from interface: DataNeedRule.SpecificDataNeedRule

This method indicates the type of the DataNeed. It returns the simple class name of the DataNeed. Primary used to indicate the type for JSON serialization.

Specified by:

getType in interface DataNeedRule.SpecificDataNeedRule<ValidatedHistoricalDataDataNeed>

Returns:

the simple class name of the DataNeed.

getDataNeedClass

public Class<ValidatedHistoricalDataDataNeed> getDataNeedClass()

Description copied from interface: DataNeedRule.SpecificDataNeedRule

Returns the type of data need that is supported by this rule.

Specified by:

getDataNeedClass in interface DataNeedRule.SpecificDataNeedRule<ValidatedHistoricalDataDataNeed>

Returns:

the type of data need that is supported by this rule.

toString

public final 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.

energyType

public EnergyType energyType()

Returns the value of the energyType record component.

Returns:

the value of the energyType record component

granularities

public List<Granularity> granularities()

Returns the value of the granularities record component.

Returns:

the value of the granularities record component