Skip to content

Commit

Permalink
Add Javadoc to public interface
Browse files Browse the repository at this point in the history
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
  • Loading branch information
jlaur committed Oct 11, 2024
1 parent 569e0be commit d9fa094
Showing 1 changed file with 15 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,22 @@
*/
@NonNullByDefault
public interface Co2EmissionListener extends SubscriptionListener {
/**
* Current realtime emission or prognosis has been updated.
*
* @param type The type (either {@link Co2EmissionSubscription.Type#Realtime} or
* {@link Co2EmissionSubscription.Type#Prognosis})
* @param emission Emission in g/kWh
*/
void onCurrentEmission(Co2EmissionSubscription.Type type, BigDecimal emission);

/**
* Realtime emissions or prognosis have changed.
* Can be used to update time series.
*
* @param type The type (either {@link Co2EmissionSubscription.Type#Realtime} or
* {@link Co2EmissionSubscription.Type#Prognosis})
* @param emissions Emissions in g/kWh
*/
void onEmissions(Co2EmissionSubscription.Type type, Map<Instant, BigDecimal> emissions);
}

0 comments on commit d9fa094

Please sign in to comment.