Package io.github.projectunified.cronutils.descriptor

Class CronDescriptor

java.lang.Object
io.github.projectunified.cronutils.descriptor.CronDescriptor
public class CronDescriptor extends Object
Provides human readable description for a given cron.

  • Field Details

    • DEFAULT_LOCALE

      public static final Locale DEFAULT_LOCALE

  • Constructor Details

    • CronDescriptor

      public CronDescriptor(ResourceBundle resourceBundle)
      Constructor creating a descriptor for given ResourceBundle.
      Parameters:
      resourceBundle - - ResourceBundle which contains descriptions

  • Method Details

    • describe

      public String describe(Cron cron)
      Provide a description of given CronFieldParseResult list.
      Parameters:
      cron - - Cron instance, never null if null, will throw NullPointerException
      Returns:
      description - String

    • describeHHmmss

      public String describeHHmmss(Map<CronFieldName,CronField> fields)
      Provide description for hours, minutes and seconds.
      Parameters:
      fields - - fields to describe;
      Returns:
      description - String

    • describeDayOfMonth

      public String describeDayOfMonth(Map<CronFieldName,CronField> fields)
      Provide description for day of month.
      Parameters:
      fields - - fields to describe;
      Returns:
      description - String

    • describeMonth

      public String describeMonth(Map<CronFieldName,CronField> fields)
      Provide description for month.
      Parameters:
      fields - - fields to describe;
      Returns:
      description - String

    • describeDayOfWeek

      public String describeDayOfWeek(Map<CronFieldName,CronField> fields, Map<CronFieldName,FieldDefinition> definitions)
      Provide description for day of week.
      Parameters:
      fields - - fields to describe;
      Returns:
      description - String

    • describeYear

      public String describeYear(Map<CronFieldName,CronField> fields)
      Provide description for a year.
      Parameters:
      fields - - fields to describe;
      Returns:
      description - String

    • instance

      public static CronDescriptor instance()
      Creates an instance with UK locale.
      Returns:
      CronDescriptor - never null.

    • instance

      public static CronDescriptor instance(Locale locale)
      Creates and instance with given locale.
      Parameters:
      locale - - Locale in which descriptions will be given
      Returns:
      CronDescriptor - never null.

    • getResourceBundle

      public ResourceBundle getResourceBundle()
      Gets the current resource bundle that is in use to allow custom reuse of text phrases.
      Returns:
      ResourceBundle - never null.