Package io.github.cdklabs.projen

Class License.Builder

java.lang.Object

io.github.cdklabs.projen.License.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<License>

Enclosing class:

License

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

(experimental) A fluent builder for License.

Method Summary

Modifier and Type	Method	Description
License	build()
License.Builder	copyrightOwner(String copyrightOwner)	(experimental) Copyright owner.
License.Builder	copyrightPeriod(String copyrightPeriod)	(experimental) Period of license (e.g.
static License.Builder	create(Project project)
License.Builder	spdx(String spdx)	(experimental) License type (SPDX).

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static License.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of License.Builder.

spdx

@Stability(Experimental)
public License.Builder spdx(String spdx)

(experimental) License type (SPDX).

Parameters:

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

Returns:

this

See Also:

https://github.com/projen/projen/tree/main/license-text for list of supported licenses

copyrightOwner

@Stability(Experimental)
public License.Builder copyrightOwner(String copyrightOwner)

(experimental) Copyright owner.

If the license text has $copyright_owner, this option must be specified.

Default: -

Parameters:

copyrightOwner - Copyright owner. This parameter is required.

Returns:

this

copyrightPeriod

@Stability(Experimental)
public License.Builder copyrightPeriod(String copyrightPeriod)

(experimental) Period of license (e.g. "1998-2023").

The string $copyright_period will be substituted with this string.

Default: - current year (e.g. "2020")

Parameters:

copyrightPeriod - Period of license (e.g. "1998-2023"). This parameter is required.

Returns:

this

build

@Stability(Experimental)
public License build()

Specified by:

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

Returns:

a newly built instance of License.