Package io.github.cdklabs.projen

Interface LicenseOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LicenseOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.774Z")
@Stability(Experimental)
public interface LicenseOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LicenseOptions.Builder	A builder for LicenseOptions
static class	LicenseOptions.Jsii$Proxy	An implementation for LicenseOptions

Method Summary

Modifier and Type	Method	Description
static LicenseOptions.Builder	builder()
default String	getCopyrightOwner()	(experimental) Copyright owner.
default String	getCopyrightPeriod()	(experimental) Period of license (e.g.
String	getSpdx()	(experimental) License type (SPDX).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSpdx

@Stability(Experimental)
@NotNull
String getSpdx()

(experimental) License type (SPDX).

See Also:

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

getCopyrightOwner

@Stability(Experimental)
@Nullable
default String getCopyrightOwner()

(experimental) Copyright owner.

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

Default: -

getCopyrightPeriod

@Stability(Experimental)
@Nullable
default String getCopyrightPeriod()

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

The string $copyright_period will be substituted with this string.

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

builder

@Stability(Experimental)
static LicenseOptions.Builder builder()

Returns:

a LicenseOptions.Builder of LicenseOptions