Package org.apache.jackrabbit.oak.spi.filter

Enum PathFilter.Result

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EXCLUDE
      Exclude the path and subtree for processing
      INCLUDE
      Include the path for processing
      TRAVERSE
      Do not process the path but just perform traversal to child nodes.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PathFilter.Result valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PathFilter.Result[] 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

      • INCLUDE

        public static final PathFilter.Result INCLUDE
        Include the path for processing

      • EXCLUDE

        public static final PathFilter.Result EXCLUDE
        Exclude the path and subtree for processing

      • TRAVERSE

        public static final PathFilter.Result TRAVERSE
        Do not process the path but just perform traversal to child nodes. For IndexEditor it means that such nodes should not be indexed but editor must traverse down

    • Method Detail

      • values

        public static PathFilter.Result[] 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 (PathFilter.Result c : PathFilter.Result.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PathFilter.Result 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