Package 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(Experimental) public static final class LicenseOptions.Builder extends Object implements software.amazon.jsii.Builder<LicenseOptions>
A builder forLicenseOptions
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LicenseOptionsbuild()Builds the configured instance.LicenseOptions.BuildercopyrightOwner(String copyrightOwner)Sets the value ofLicenseOptions.getCopyrightOwner()LicenseOptions.BuildercopyrightPeriod(String copyrightPeriod)Sets the value ofLicenseOptions.getCopyrightPeriod()LicenseOptions.Builderspdx(String spdx)Sets the value ofLicenseOptions.getSpdx()
-
-
-
Method Detail
-
spdx
@Stability(Experimental) public LicenseOptions.Builder spdx(String spdx)
Sets the value ofLicenseOptions.getSpdx()- Parameters:
spdx- License type (SPDX). This parameter is required.- Returns:
this
-
copyrightOwner
@Stability(Experimental) public LicenseOptions.Builder copyrightOwner(String copyrightOwner)
Sets the value ofLicenseOptions.getCopyrightOwner()- Parameters:
copyrightOwner- Copyright owner. If the license text has $copyright_owner, this option must be specified.- Returns:
this
-
copyrightPeriod
@Stability(Experimental) public LicenseOptions.Builder copyrightPeriod(String copyrightPeriod)
Sets the value ofLicenseOptions.getCopyrightPeriod()- Parameters:
copyrightPeriod- Period of license (e.g. "1998-2023"). The string$copyright_periodwill be substituted with this string.- Returns:
this
-
build
@Stability(Experimental) public LicenseOptions build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<LicenseOptions>- Returns:
- a new instance of
LicenseOptions - Throws:
NullPointerException- if any required attribute was not provided
-
-