Package org.kohsuke.stapler.export
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.kohsuke.stapler.export.TreePruner
TreePruner.ByDepth
-
-
Field Summary
-
Fields inherited from class org.kohsuke.stapler.export.TreePruner
DEFAULT
-
-
Constructor Summary
Constructors Constructor Description NamedPathPruner(String spec)
Constructs a pruner by parsing a textual specification.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TreePruner
accept(Object node, Property prop)
Called before Hudson writes a new property.Range
getRange()
-
-
-
Constructor Detail
-
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 propertya
but none of its children, and the top-level propertyb
and only those of its children namedc
andd
.- Parameters:
spec
- textual specification of tree- Throws:
IllegalArgumentException
- if the syntax is incorrect
-
-
Method Detail
-
accept
public TreePruner accept(Object node, Property prop)
Description copied from class:TreePruner
Called before Hudson writes a new property.- Specified by:
accept
in classTreePruner
- 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 classTreePruner
-
-