Package choreo.util

Class ChoreoAlert

java.lang.Object

choreo.util.ChoreoAlert

public class ChoreoAlert
extends Object

A utility class for creating alerts under the "Choreo Alerts" group.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChoreoAlert.MultiAlert	An alert that can have multiple causes.

Field Summary

Fields

Modifier and Type	Field	Description
static final Alert	allianceNotReady	An alert to be used when alliance-dependent logic is called before an alliance has been determined.

Method Summary

Modifier and Type	Method	Description
static Alert	alert(String name, Alert.AlertType type)	Creates an alert under the "Choreo" group.
static ChoreoAlert.MultiAlert	multiAlert(Function<List<String>,String> textGenerator, Alert.AlertType type)	Creates a ChoreoAlert.MultiAlert under the "Choreo" group.

Methods inherited from class java.lang.Object

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

Field Details

allianceNotReady

public static final Alert allianceNotReady

An alert to be used when alliance-dependent logic is called before an alliance has been determined.

Method Details

alert

public static Alert alert(String name,
 Alert.AlertType type)

Creates an alert under the "Choreo" group.

Parameters:

name - The name of the alert

type - The type of alert

Returns:

an Alert published under the "Choreo" group

multiAlert

public static ChoreoAlert.MultiAlert multiAlert(Function<List<String>,String> textGenerator,
 Alert.AlertType type)

Creates a ChoreoAlert.MultiAlert under the "Choreo" group.

Parameters:

textGenerator - A function that accepts a list of causes and returns an alert message

type - The type of alert

Returns:

a MultiAlert published under the "Choreo" group