io.github.cdklabs.projen

Class LicenseOptions.Builder

java.lang.Object

io.github.cdklabs.projen.LicenseOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LicenseOptions>

Enclosing interface:

LicenseOptions

@Stability(value=Experimental)
public static final class LicenseOptions.Builder
extends Object
implements software.amazon.jsii.Builder<LicenseOptions>

A builder for LicenseOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LicenseOptions	build() Builds the configured instance.
LicenseOptions.Builder	copyrightOwner(String copyrightOwner) Sets the value of LicenseOptions.getCopyrightOwner()
LicenseOptions.Builder	copyrightPeriod(String copyrightPeriod) Sets the value of LicenseOptions.getCopyrightPeriod()
LicenseOptions.Builder	spdx(String spdx) Sets the value of LicenseOptions.getSpdx()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

spdx

@Stability(value=Experimental)
public LicenseOptions.Builder spdx(String spdx)

Sets the value of LicenseOptions.getSpdx()

Parameters:

spdx - License type (SPDX). This parameter is required.

Returns:

this

copyrightOwner

@Stability(value=Experimental)
public LicenseOptions.Builder copyrightOwner(String copyrightOwner)

Sets the value of LicenseOptions.getCopyrightOwner()

Parameters:

copyrightOwner - Copyright owner. If the license text has $copyright_owner, this option must be specified.

Returns:

this

copyrightPeriod

@Stability(value=Experimental)
public LicenseOptions.Builder copyrightPeriod(String copyrightPeriod)

Sets the value of LicenseOptions.getCopyrightPeriod()

Parameters:

copyrightPeriod - Period of license (e.g. "1998-2023"). The string $copyright_period will be substituted with this string.

Returns:

this

build

@Stability(value=Experimental)
public LicenseOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<LicenseOptions>

Returns:

a new instance of LicenseOptions

Throws:

NullPointerException - if any required attribute was not provided