ComponentSetup Class

public final class ComponentSetup
extends CustomSetupBase

The custom setup of installing 3rd party components.

Constructor Summary

Constructor Description
ComponentSetup()

Creates an instance of ComponentSetup class.

Method Summary

Modifier and Type Method and Description
String componentName()

Get the componentName property: The name of the 3rd party component.

static ComponentSetup fromJson(JsonReader jsonReader)

Reads an instance of ComponentSetup from the JsonReader.

SecretBase licenseKey()

Get the licenseKey property: The license key to activate the component.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of custom setup.

void validate()

Validates the instance.

ComponentSetup withComponentName(String componentName)

Set the componentName property: The name of the 3rd party component.

ComponentSetup withLicenseKey(SecretBase licenseKey)

Set the licenseKey property: The license key to activate the component.

Methods inherited from CustomSetupBase

Methods inherited from java.lang.Object

Constructor Details

ComponentSetup

public ComponentSetup()

Creates an instance of ComponentSetup class.

Method Details

componentName

public String componentName()

Get the componentName property: The name of the 3rd party component.

Returns:

the componentName value.

fromJson

public static ComponentSetup fromJson(JsonReader jsonReader)

Reads an instance of ComponentSetup from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ComponentSetup if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

licenseKey

public SecretBase licenseKey()

Get the licenseKey property: The license key to activate the component.

Returns:

the licenseKey value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ComponentSetup.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of custom setup.

Overrides:

ComponentSetup.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ComponentSetup.validate()

withComponentName

public ComponentSetup withComponentName(String componentName)

Set the componentName property: The name of the 3rd party component.

Parameters:

componentName - the componentName value to set.

Returns:

the ComponentSetup object itself.

withLicenseKey

public ComponentSetup withLicenseKey(SecretBase licenseKey)

Set the licenseKey property: The license key to activate the component.

Parameters:

licenseKey - the licenseKey value to set.

Returns:

the ComponentSetup object itself.

Applies to