Class Category


  • public final class Category
    extends java.lang.Object
    A rule's category. Categories are used to group rules for a better overview.
    • Field Detail

      • name

        private final java.lang.String name
      • defaultOff

        private final boolean defaultOff
      • tabname

        private final java.lang.String tabname
    • Constructor Detail

      • Category

        public Category​(CategoryId id,
                        java.lang.String name)
        Since:
        3.3
      • Category

        public Category​(CategoryId id,
                        java.lang.String name,
                        Category.Location location,
                        boolean onByDefault,
                        java.lang.String tabname)
        Since:
        4.3
    • Method Detail

      • getId

        @Nullable
        public @Nullable CategoryId getId()
        Since:
        3.3
      • getName

        public java.lang.String getName()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getTabName

        @Nullable
        public @Nullable java.lang.String getTabName()
        Since:
        4.3
      • isDefaultOff

        public boolean isDefaultOff()
        Checks whether the category has been turned off by default by the category author.
        Returns:
        True if the category is turned off by default.