001// Copyright (c) FIRST and other WPILib contributors.
002// Open Source Software; you can modify and/or share it under the terms of
003// the WPILib BSD license file in the root directory of this project.
004
005package edu.wpi.first.wpilibj.shuffleboard;
006
007/**
008 * Represents the type of a widget in Shuffleboard. Using this is preferred over specifying raw
009 * strings, to avoid typos and having to know or look up the exact string name for a desired widget.
010 *
011 * @see BuiltInWidgets the built-in widget types
012 */
013@SuppressWarnings("PMD.ImplicitFunctionalInterface")
014public interface WidgetType {
015  /**
016   * Gets the string type of the widget as defined by that widget in Shuffleboard.
017   *
018   * @return The string type of the widget.
019   */
020  String getWidgetName();
021}