Skip to content

Commit c6df643

Browse files
committed
[java] style updates to satisfy checkstyle
1 parent d621b05 commit c6df643

34 files changed

+469
-138
lines changed

.rubocop.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
inherit_from: ruby/.rubocop.yml

checkstyle-suppressions.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0"?>
2+
3+
<!DOCTYPE suppressions PUBLIC
4+
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
5+
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
6+
7+
<suppressions>
8+
<suppress checks="MissingJavadoc*" files="/test/"/>
9+
<suppress checks=".*" files="/(junit4|junit5|testng)/"/>
10+
</suppressions>

checkstyle.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,15 +245,15 @@
245245
<module name="Indentation">
246246
<property name="basicOffset" value="4"/>
247247
<property name="braceAdjustment" value="0"/>
248-
<property name="caseIndent" value="4"/>
248+
<property name="caseIndent" value="0"/>
249249
<property name="throwsIndent" value="4"/>
250250
<property name="lineWrappingIndentation" value="4"/>
251251
<property name="arrayInitIndent" value="4"/>
252252
</module>
253253
<module name="AbbreviationAsWordInName">
254254
<property name="ignoreFinal" value="false"/>
255255
<property name="allowedAbbreviationLength" value="3"/>
256-
<property name="allowedAbbreviations" value="XML, URL, JUnit, TestNG" />
256+
<property name="allowedAbbreviations" value="XML, URL, JUnit, TestNG, APAC" />
257257
<property name="tokens"
258258
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
259259
PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,

java/main/src/main/java/com/saucelabs/saucebindings/Browser.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
import java.util.Map;
77
import java.util.Set;
88

9+
/**
10+
* Valid Browsers.
11+
*
12+
* @see <a href="https://docs.saucelabs.com/dev/test-configuration-options/#browsername">browserName</a>
13+
*/
914
public enum Browser {
1015
CHROME("chrome"),
1116
INTERNET_EXPLORER("internet explorer"),

java/main/src/main/java/com/saucelabs/saucebindings/CITools.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ private static void storeBuildInfo() {
5555

5656
/**
5757
* The default build name based on CI Tool.
58+
*
5859
* @return the constant name of the build
5960
*/
6061
public static String getBuildName() {
@@ -64,6 +65,7 @@ public static String getBuildName() {
6465

6566
/**
6667
* The default build number based on CI Tool.
68+
*
6769
* @return the variable number of the current build
6870
*/
6971
public static String getBuildNumber() {

java/main/src/main/java/com/saucelabs/saucebindings/DataCenter.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
import lombok.Getter;
44

5+
/**
6+
* Valid Data Center Server Names.
7+
*
8+
* @see <a href="https://docs.saucelabs.com/basics/data-center-endpoints/">Data Center Endpoints</a>
9+
*/
510
@Getter
611
public enum DataCenter {
712
US_WEST("us-west-1"),

java/main/src/main/java/com/saucelabs/saucebindings/JobVisibility.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
import java.util.Map;
77
import java.util.Set;
88

9+
/**
10+
* Valid Job Visibility Options.
11+
* The Sauce Labs name for this capability is "public"
12+
*
13+
* @see <a href="https://docs.saucelabs.com/dev/test-configuration-options/#public">public</a>
14+
*/
915
public enum JobVisibility {
1016
PUBLIC("public"),
1117
PUBLIC_RESTRICTED("public restricted"),

java/main/src/main/java/com/saucelabs/saucebindings/PageLoadStrategy.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
import java.util.Map;
77
import java.util.Set;
88

9+
/**
10+
* Valid Page Load Strategies.
11+
*
12+
* @see <a href="https://docs.saucelabs.com/dev/test-configuration-options/#pageloadstrategy">pageLoadStrategy</a>
13+
*/
914
public enum PageLoadStrategy {
1015
NONE("none"),
1116
EAGER("eager"),

java/main/src/main/java/com/saucelabs/saucebindings/Prerun.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
import java.util.Map;
77
import java.util.Set;
88

9+
/**
10+
* Valid Pre-run executable options.
11+
*
12+
* @see <a href="https://docs.saucelabs.com/dev/test-configuration-options/#pre-run-executables">Pre-Run Executables</a>
13+
*/
914
public enum Prerun {
1015
EXECUTABLE("executable"),
1116
ARGS("args"),

java/main/src/main/java/com/saucelabs/saucebindings/SauceEnvironmentVariablesNotSetException.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
package com.saucelabs.saucebindings;
22

3+
/**
4+
* Setting Environment Variables to Authenticate with Sauce Labs is required.
5+
*/
36
class SauceEnvironmentVariablesNotSetException extends RuntimeException {
47
public SauceEnvironmentVariablesNotSetException(String message) {
58
super(message);

0 commit comments

Comments
 (0)