com.codepine.api.testrail

Class TestRail.Builder

java.lang.Object

com.codepine.api.testrail.TestRail.Builder

Enclosing class:

TestRail

public static class TestRail.Builder
extends Object

Builder for TestRail.

Method Summary

Modifier and Type	Method and Description
TestRail.Builder	apiPath(String apiPath) Set the URL path of your TestRail API.
TestRail.Builder	applicationName(String applicationName) Set the name of the application which will communicate with TestRail.
TestRail	build() Build an instance of TestRail.

Methods inherited from class java.lang.Object

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

Method Detail

apiPath

public TestRail.Builder apiPath(@NonNull
                                String apiPath)

Set the URL path of your TestRail API. Useful to override the default API path of standard TestRail deployments.

Parameters:

apiPath - the URL path of your TestRail API

Returns:

this for chaining

Throws:

NullPointerException - if apiPath is null

applicationName

public TestRail.Builder applicationName(@NonNull
                                        String applicationName)

Set the name of the application which will communicate with TestRail.

Parameters:

applicationName - name of the application

Returns:

this for chaining

Throws:

NullPointerException - if applicationName is null

build

public TestRail build()

Build an instance of TestRail.

Returns:

a new instance