Package net.kyori.indra.api.model

Interface ApplyTo

  • @Modifiable
public interface ApplyTo
    A representation of services that can be configured for a specific forge site (GitHub, GitLab, etc).

    ApplyTo instances are mutable and must not be shared.

    Since:
    1.0.0

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default boolean ci()
      Get whether CI configuration will be applied.
      @NonNull ApplyTo ci​(boolean ci)
      Set whether continuous integration configuration will be applied.
      static @NonNull ApplyTo defaults()
      Create a new instance with default values.
      default boolean issues()
      Get whether issues configuration will be applied.
      @NonNull ApplyTo issues​(boolean issues)
      Set whether issue tracker configuration will be applied.
      default boolean publishing()
      Get whether publishing configuration will be applied.
      @NonNull ApplyTo publishing​(boolean publishing)
      Set whether publishing will be applied.
      default boolean scm()
      Get whether scm configuration will be applied.
      @NonNull ApplyTo scm​(boolean scm)
      Set whether scm will be applied.

    • Method Detail

      • defaults

        static @NonNull ApplyTo defaults()
        Create a new instance with default values.
        Returns:
        the new instance
        Since:
        2.0.0

      • ci

        @Default
default boolean ci()
        Get whether CI configuration will be applied.
        Returns:
        whether to apply CI configuration
        Since:
        1.2.0

      • ci

        @NonNull ApplyTo ci​(boolean ci)
        Set whether continuous integration configuration will be applied.
        Parameters:
        ci - whether to apply continuous integration configuration
        Returns:
        this instance
        Since:
        1.2.0

      • issues

        @Default
default boolean issues()
        Get whether issues configuration will be applied.
        Returns:
        whether to apply issues configuration
        Since:
        1.0.0

      • issues

        @NonNull ApplyTo issues​(boolean issues)
        Set whether issue tracker configuration will be applied.
        Parameters:
        issues - whether to apply issue tracker configuration
        Returns:
        this instance
        Since:
        1.0.0

      • scm

        @Default
default boolean scm()
        Get whether scm configuration will be applied.
        Returns:
        whether to apply scm
        Since:
        1.0.0

      • scm

        @NonNull ApplyTo scm​(boolean scm)
        Set whether scm will be applied.
        Parameters:
        scm - whether to apply scm
        Returns:
        this instance
        Since:
        1.0.0

      • publishing

        @Default
default boolean publishing()
        Get whether publishing configuration will be applied.
        Returns:
        whether to apply publishing
        Since:
        1.0.0

      • publishing

        @NonNull ApplyTo publishing​(boolean publishing)
        Set whether publishing will be applied.
        Parameters:
        publishing - whether to apply publishing
        Returns:
        this instance
        Since:
        1.0.0