SendableChooser: Rename addDefault and addObject for clarity (#1239)

Rename addDefault to setDefaultOption and addObject to addOption.

The old names are still available but are marked as deprecated.
This commit is contained in:
Peter Johnson
2018-08-19 01:51:17 -07:00
committed by GitHub
parent fa78f30e30
commit b44f27ddfa
13 changed files with 66 additions and 31 deletions

View File

@@ -76,23 +76,49 @@ public class SendableChooser<V> extends SendableBase {
* @param name the name of the option
* @param object the option
*/
public void addObject(String name, V object) {
public void addOption(String name, V object) {
m_map.put(name, object);
}
/**
* Add the given object to the list of options and marks it as the default. Functionally, this is
* very close to {@link #addObject(String, Object)} except that it will use this as the default
* Adds the given object to the list of options.
*
* @deprecated Use {@link #addOption(String, Object)} instead.
*
* @param name the name of the option
* @param object the option
*/
@Deprecated
public void addObject(String name, V object) {
addOption(name, object);
}
/**
* Adds the given object to the list of options and marks it as the default. Functionally, this is
* very close to {@link #addOption(String, Object)} except that it will use this as the default
* option if none other is explicitly selected.
*
* @param name the name of the option
* @param object the option
*/
public void addDefault(String name, V object) {
public void setDefaultOption(String name, V object) {
requireNonNull(name, "Provided name was null");
m_defaultChoice = name;
addObject(name, object);
addOption(name, object);
}
/**
* Adds the given object to the list of options and marks it as the default.
*
* @deprecated Use {@link #setDefaultOption(String, Object)} instead.
*
* @param name the name of the option
* @param object the option
*/
@Deprecated
public void addDefault(String name, V object) {
setDefaultOption(name, object);
}
/**