Constructor Detail

• BinaryCompatibilityValidatorConfig

  BinaryCompatibilityValidatorConfig(Set<String> ignoredPackages, Set<String> nonPublicMarkers, Set<String> ignoredClasses, Boolean disableForNonRelease, Boolean jsApiChecks, Boolean klibValidationEnabled, Integer klibSignatureVersion)

Method Detail

• getIgnoredPackages

   final Set<String> getIgnoredPackages()

  Fully qualified package names that not consider public API. For example, it could be kotlinx.coroutines.internal or kotlinx.serialization.implementation.

• setIgnoredPackages

   final Unit setIgnoredPackages(Set<String> ignoredPackages)

  Fully qualified package names that not consider public API. For example, it could be kotlinx.coroutines.internal or kotlinx.serialization.implementation.

• getNonPublicMarkers

   final Set<String> getNonPublicMarkers()

  Fully qualified names of annotations that effectively exclude declarations from being public. Example of such annotation could be kotlinx.coroutines.InternalCoroutinesApi.

  JvmSynthetic is added by default.

• setNonPublicMarkers

   final Unit setNonPublicMarkers(Set<String> nonPublicMarkers)

  Fully qualified names of annotations that effectively exclude declarations from being public. Example of such annotation could be kotlinx.coroutines.InternalCoroutinesApi.

  JvmSynthetic is added by default.

• getIgnoredClasses

   final Set<String> getIgnoredClasses()

  Fully qualified names of classes that ignored by the API check. Example of such a class could be com.package.android.BuildConfig.

  DefaultConstructorMarker is added by default.

• setIgnoredClasses

   final Unit setIgnoredClasses(Set<String> ignoredClasses)

  Fully qualified names of classes that ignored by the API check. Example of such a class could be com.package.android.BuildConfig.

  DefaultConstructorMarker is added by default.

• getDisableForNonRelease

   final Boolean getDisableForNonRelease()

  Whether to turn off validation for non-release builds.

• setDisableForNonRelease

   final Unit setDisableForNonRelease(Boolean disableForNonRelease)

  Whether to turn off validation for non-release builds.

• getJsApiChecks

   final Boolean getJsApiChecks()

  Whether to verify JS API. Uses compiled TypeScript definitions.

  See fluxo-bcv-js for more info.

• setJsApiChecks

   final Unit setJsApiChecks(Boolean jsApiChecks)

  Whether to verify JS API. Uses compiled TypeScript definitions.

  See fluxo-bcv-js for more info.

• getKlibValidationEnabled

   final Boolean getKlibValidationEnabled()

  Whether to verify KLib (Kotlin/Native) APIs.

• setKlibValidationEnabled

   final Unit setKlibValidationEnabled(@Incubating() Boolean klibValidationEnabled)

  Whether to verify KLib (Kotlin/Native) APIs.

• getKlibSignatureVersion

   final Integer getKlibSignatureVersion()

  When enabled, KLib validation will use v2-signatures in dumps. It could be changed to 1 to use v1-signatures.

  If validated klib doesn't contain appropriate signatures, an exception will be thrown during the validation.

• setKlibSignatureVersion

   final Unit setKlibSignatureVersion(@Incubating() Integer klibSignatureVersion)

  When enabled, KLib validation will use v2-signatures in dumps. It could be changed to 1 to use v1-signatures.

  If validated klib doesn't contain appropriate signatures, an exception will be thrown during the validation.