Using an enum for select style

Author: fo-code

src/main/java/io/jenkins/plugins/datatables/TableConfiguration.java

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.jenkins.plugins.datatables.options.SelectStyle;
 
 /**
  * Provides a configuration for the whole DataTable. This is merged with a default configuration in table.js.
@@ -105,15 +106,15 @@ public boolean isUseButtons() {
     /**
      * Enable selection.
      *
-     * @param selectionStyle
-     *          The <a href="https://datatables.net/reference/option/select.style">select.style</a> option
+     * @param selectStyle
+     *          The {@link SelectStyle selection style}
      *
      * @return this {@link TableConfiguration} for chaining methods
      *
      * @see <a href="https://datatables.net/reference/option/select">https://datatables.net/reference/option/select</a>
      */
-    public TableConfiguration select(final String selectionStyle) {
-        configuration.put("select", selectionStyle);
+    public TableConfiguration select(final SelectStyle selectStyle) {
+        configuration.put("select", selectStyle.getStyle());
         useSelect = true;
         return this;
     }

src/main/java/io/jenkins/plugins/datatables/options/SelectStyle.java

@@ -0,0 +1,50 @@
+package io.jenkins.plugins.datatables.options;
+
+/**
+ * The possible values of the <a href="https://datatables.net/reference/option/select.style">select.style</a> option,
+ * which is used for enabling the selection for datatables and setting its style (the default is {@link #OS}.
+ *
+ * @author Florian Orendi
+ */
+public enum SelectStyle {
+
+    /**
+     * Selection can only be performed via the API.
+     */
+    API("api"),
+
+    /**
+     * Only a single item can be selected, any other selected items will be automatically
+     * deselected when a new item is selected.
+     */
+    SINGLE("single"),
+
+    /**
+     * Multiple items can be selected. Selection is performed by simply clicking on the items to be selected.
+     */
+    MULTI("multi"),
+
+    /**
+     * Operating System (OS) style selection.
+     * This is the most comprehensive option and provides complex behaviours such as ctrl/cmd clicking
+     * to select / deselect individual items, shift clicking to select ranges
+     * and an unmodified click to select a single item.
+     */
+    OS("os"),
+
+    /**
+     * A hybrid between the {@link #OS} style and {@link #MULTI},
+     * allowing easy multi-row selection without immediate de-selection when clicking on a row.
+     */
+    MULTI_SHIFT("multi+shift");
+
+    private final String style;
+
+    SelectStyle(final String style) {
+        this.style = style;
+    }
+
+    public String getStyle() {
+        return style;
+    }
+}

src/test/java/io/jenkins/plugins/datatables/TableConfigurationTest.java

@@ -1,5 +1,6 @@
 package io.jenkins.plugins.datatables;
 
+import io.jenkins.plugins.datatables.options.SelectStyle;
 import org.junit.jupiter.api.Test;
 
 import static io.jenkins.plugins.datatables.TableConfigurationAssert.*;
@@ -34,7 +35,7 @@ void shouldCreateResponsiveConfiguration() {
 
     @Test
     void shouldCreateSelectConfiguration() {
-        TableConfiguration configuration = new TableConfiguration().select("single");
+        TableConfiguration configuration = new TableConfiguration().select(SelectStyle.SINGLE);
 
         assertThat(configuration).hasConfiguration("{\"select\":\"single\"}");
         assertThat(configuration).isNotUseButtons();