Enum SoPattern.FilterTypes

  • All Implemented Interfaces:
    IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoPattern.FilterTypes>
    Enclosing class:
    SoPattern

    public static enum SoPattern.FilterTypes
    extends java.lang.Enum<SoPattern.FilterTypes>
    implements IntegerValuedEnum
    Possible value of the filterType used by the method loadPatterns. In the case INCLUSIVE_FILTER, we only load patterns of the file define by the list of patterns names. In the case EXCLUSIVE_FILTER, we load all patterns defined in the file without those define by the list of patterns names.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EXCLUSIVE_FILTER
      Load all patterns except those specified in the list of pattern names.
      INCLUSIVE_FILTER
      Load only the patterns that are in the list of pattern names.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getValue()
      Returns the integer value of the enum constant.
      static SoPattern.FilterTypes valueOf​(int val)
      Returns the enum constant of this type with the specified integer value
      static SoPattern.FilterTypes valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SoPattern.FilterTypes[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • INCLUSIVE_FILTER

        public static final SoPattern.FilterTypes INCLUSIVE_FILTER
        Load only the patterns that are in the list of pattern names.
      • EXCLUSIVE_FILTER

        public static final SoPattern.FilterTypes EXCLUSIVE_FILTER
        Load all patterns except those specified in the list of pattern names.
    • Method Detail

      • values

        public static SoPattern.FilterTypes[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SoPattern.FilterTypes c : SoPattern.FilterTypes.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SoPattern.FilterTypes valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • valueOf

        public static SoPattern.FilterTypes valueOf​(int val)
        Returns the enum constant of this type with the specified integer value
        Returns:
        the enum constant of this type with the specified integer value.
      • getValue

        public int getValue()
        Description copied from interface: IntegerValuedEnum
        Returns the integer value of the enum constant.
        Specified by:
        getValue in interface IntegerValuedEnum
        Returns:
        the integer value of the enum constant.