Package io.github.projectunified.cronutils.model.definition

Class CronDefinitionBuilder

java.lang.Object
io.github.projectunified.cronutils.model.definition.CronDefinitionBuilder
public class CronDefinitionBuilder extends Object
Builder that allows to define and create CronDefinition instances.

  • Method Details

    • defineCron

      public static CronDefinitionBuilder defineCron()
      Creates a builder instance.
      Returns:
      new CronDefinitionBuilder instance

    • withSeconds

      public FieldDefinitionBuilder withSeconds()
      Adds definition for seconds field.
      Returns:
      new FieldDefinitionBuilder instance

    • withMinutes

      public FieldDefinitionBuilder withMinutes()
      Adds definition for minutes field.
      Returns:
      new FieldDefinitionBuilder instance

    • withHours

      public FieldDefinitionBuilder withHours()
      Adds definition for hours field.
      Returns:
      new FieldDefinitionBuilder instance

    • withDayOfMonth

      public FieldSpecialCharsDefinitionBuilder withDayOfMonth()
      Adds definition for day of month field.
      Returns:
      new FieldSpecialCharsDefinitionBuilder instance

    • withMonth

      public FieldDefinitionBuilder withMonth()
      Adds definition for month field.
      Returns:
      new FieldDefinitionBuilder instance

    • withDayOfWeek

      public FieldDayOfWeekDefinitionBuilder withDayOfWeek()
      Adds definition for day of week field.
      Returns:
      new FieldSpecialCharsDefinitionBuilder instance

    • withYear

      public FieldDefinitionBuilder withYear()
      Adds definition for year field.
      Returns:
      new FieldDefinitionBuilder instance

    • withDayOfYear

      public FieldQuestionMarkDefinitionBuilder withDayOfYear()
      Adds definition for day of year field.
      Returns:
      new FieldDefinitionBuilder instance

    • matchDayOfWeekAndDayOfMonth

      public CronDefinitionBuilder matchDayOfWeekAndDayOfMonth()
      Sets matchDayOfWeekAndDayOfMonth value to true.
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameYearly

      public CronDefinitionBuilder withSupportedNicknameYearly()
      Supports cron nickname @yearly
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameAnnually

      public CronDefinitionBuilder withSupportedNicknameAnnually()
      Supports cron nickname @annually
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameMonthly

      public CronDefinitionBuilder withSupportedNicknameMonthly()
      Supports cron nickname @monthly
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameWeekly

      public CronDefinitionBuilder withSupportedNicknameWeekly()
      Supports cron nickname @weekly
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameDaily

      public CronDefinitionBuilder withSupportedNicknameDaily()
      Supports cron nickname @daily
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameMidnight

      public CronDefinitionBuilder withSupportedNicknameMidnight()
      Supports cron nickname @midnight
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameHourly

      public CronDefinitionBuilder withSupportedNicknameHourly()
      Supports cron nickname @hourly
      Returns:
      this CronDefinitionBuilder instance

    • withSupportedNicknameReboot

      public CronDefinitionBuilder withSupportedNicknameReboot()
      Supports cron nickname @reboot
      Returns:
      this CronDefinitionBuilder instance

    • withCronValidation

      public CronDefinitionBuilder withCronValidation(CronConstraint validation)
      Adds a cron validation.
      Parameters:
      validation - - constraint validation
      Returns:
      this CronDefinitionBuilder instance

    • register

      public void register(FieldDefinition definition)
      Registers a certain FieldDefinition.
      Parameters:
      definition - - FieldDefinition instance, never null

    • instance

      public CronDefinition instance()
      Creates a new CronDefinition instance with provided field definitions.
      Returns:
      returns CronDefinition instance, never null

    • instanceDefinitionFor

      public static CronDefinition instanceDefinitionFor(CronType cronType)
      Creates CronDefinition instance matching cronType specification.
      Parameters:
      cronType - - some cron type. If null, a RuntimeException will be raised.
      Returns:
      CronDefinition instance if definition is found; a RuntimeException otherwise.