Interface PluginPushOption


public interface PluginPushOption
Push option that can be specified on push.

On push the option has to be specified as -o <pluginName>~<name>=<value>, or if a value is not required as -o <pluginName>~<name>.

  • Method Summary

    Modifier and Type
    Method
    Description
    The description of the push option.
    The name of the push option.
    default boolean
    Allows implementers to control if the option is enabled at the project + branch level
    default boolean
    Allows implementers to control if the option is enabled at the change level
  • Method Details

    • getName

      String getName()
      The name of the push option.
    • getDescription

      String getDescription()
      The description of the push option.
    • isOptionEnabled

      default boolean isOptionEnabled(ChangeNotes changeNotes)
      Allows implementers to control if the option is enabled at the change level
      Parameters:
      changeNotes - the change for which it should be checked if the option is enabled
    • isOptionEnabled

      default boolean isOptionEnabled(Project.NameKey project, BranchNameKey branch)
      Allows implementers to control if the option is enabled at the project + branch level
      Parameters:
      project - the project for which it should be checked if the option is enabled
      branch - the branch for which it should be checked if the option is enabled