Class NamedPathPruner

java.lang.Object
org.kohsuke.stapler.export.TreePruner
org.kohsuke.stapler.export.NamedPathPruner

public final class NamedPathPruner extends TreePruner
Tree pruner which operates according to a textual description of what tree leaves should be included.
  • Constructor Details

    • NamedPathPruner

      public NamedPathPruner(String spec) throws IllegalArgumentException
      Constructs a pruner by parsing a textual specification. This lists the properties which should be included at each level of the hierarchy. Properties are separated by commas and nested objects are inside square braces. For example, a,b[c,d] will emit the top-level property a but none of its children, and the top-level property b and only those of its children named c and d.
      Parameters:
      spec - textual specification of tree
      Throws:
      IllegalArgumentException - if the syntax is incorrect
  • Method Details

    • accept

      public TreePruner accept(Object node, Property prop)
      Description copied from class: TreePruner
      Called before Hudson writes a new property.
      Specified by:
      accept in class TreePruner
      Returns:
      null if this property shouldn't be written. Otherwise the returned TreePruner object will be consulted to determine properties of the child object in turn.
    • getRange

      public Range getRange()
      Overrides:
      getRange in class TreePruner