Package org.kohsuke.stapler.export
Class TreePruner
- java.lang.Object
-
- org.kohsuke.stapler.export.TreePruner
-
- Direct Known Subclasses:
NamedPathPruner
,TreePruner.ByDepth
public abstract class TreePruner extends Object
Controls the portion of the object graph to be written toDataWriter
.- Author:
- Kohsuke Kawaguchi
- See Also:
Model.writeTo(Object, TreePruner, DataWriter)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TreePruner.ByDepth
-
Field Summary
Fields Modifier and Type Field Description static TreePruner
DEFAULT
Probably the most commonTreePruner
that just visits the top object and its properties, but none of the referenced objects.
-
Constructor Summary
Constructors Constructor Description TreePruner()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract TreePruner
accept(Object node, Property prop)
Called before Hudson writes a new property.Range
getRange()
-
-
-
Field Detail
-
DEFAULT
public static final TreePruner DEFAULT
Probably the most commonTreePruner
that just visits the top object and its properties, but none of the referenced objects.
-
-
Method Detail
-
accept
public abstract TreePruner accept(Object node, Property prop)
Called before Hudson writes a new property.- 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()
-
-