Package net.kyori.indra.api.model

Interface License

@Immutable public interface License
License information for the current project.
Since:
2.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    License.Builder
    A builder for Licenses.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull License
    apache2()
    Get an Apache 2.0 license instance.
    static @NotNull License.Builder
    builder()
    Create a builder to construct a custom license.
    static @NotNull License
    gpl3Only()
    Get a GPL-3.0-only license instance.
    static @NotNull License
    gpl3OrLater()
    Get a GPL-3.0-or-later license instance.
    static @NotNull License
    lgpl3Only()
    Get an LGPL-3.0-only license instance.
    static @NotNull License
    lgpl3OrLater()
    Get an LGPL-3.0-or-later license instance.
    static @NotNull License
    mit()
    Get an MIT license instance.
    static @NotNull License
    mpl2()
    Get an MPL-2 license instance.
    @NotNull String
    name()
    Get the display name of this license.
    @Nullable String
    spdx()
    Get the SPDX identifier that describes this license.
    @NotNull String
    url()
    Get a URL to the text of this license.

  • Method Details

    • builder

      @NotNull static @NotNull License.Builder builder()
      Create a builder to construct a custom license.
      Returns:
      the license builder
      Since:
      2.0.0

    • apache2

      @NotNull static @NotNull License apache2()
      Get an Apache 2.0 license instance.
      Returns:
      the Apache 2.0 license
      Since:
      2.0.0

    • gpl3Only

      @NotNull static @NotNull License gpl3Only()
      Get a GPL-3.0-only license instance.
      Returns:
      the GPL-3.0-only license
      Since:
      2.0.0

    • gpl3OrLater

      @NotNull static @NotNull License gpl3OrLater()
      Get a GPL-3.0-or-later license instance.
      Returns:
      the GPL-3.0-or-later license
      Since:
      2.1.0

    • lgpl3Only

      @NotNull static @NotNull License lgpl3Only()
      Get an LGPL-3.0-only license instance.
      Returns:
      the LGPL-3.0-only license
      Since:
      2.1.0

    • lgpl3OrLater

      @NotNull static @NotNull License lgpl3OrLater()
      Get an LGPL-3.0-or-later license instance.
      Returns:
      the LGPL-3.0-or-later license
      Since:
      2.1.0

    • mit

      @NotNull static @NotNull License mit()
      Get an MIT license instance.
      Returns:
      the MIT license
      Since:
      2.0.0

    • mpl2

      @NotNull static @NotNull License mpl2()
      Get an MPL-2 license instance.
      Returns:
      the MPL-2 license
      Since:
      2.1.0

    • spdx

      @Nullable @Nullable String spdx()
      Get the SPDX identifier that describes this license.
      Returns:
      spdx the license identifier
      Since:
      2.0.0

    • name

      @NotNull @NotNull String name()
      Get the display name of this license.
      Returns:
      the license display name
      Since:
      2.0.0

    • url

      @NotNull @NotNull String url()
      Get a URL to the text of this license.
      Returns:
      a URL pointing to this license text
      Since:
      2.0.0