org.kohsuke.stapler.export

Class Model<T>

java.lang.Object

org.kohsuke.stapler.export.Model<T>

public class Model<T>
extends Object

Writes all the property of one ExportedBean to DataWriter.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
Model<? super T>	superModel Model for the super class.
Class<T>	type The class being modeled.

Method Summary

Modifier and Type	Method and Description
List<Property>	getProperties() Gets all the exported properties.
void	writeTo(T object, DataWriter writer) Writes the property values of the given object to the writer.
void	writeTo(T object, int baseVisibility, DataWriter writer) Deprecated. as of 1.139
void	writeTo(T object, TreePruner pruner, DataWriter writer) Writes the property values of the given object to the writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public final Class<T> type

The class being modeled.

superModel

public final Model<? super T> superModel

Model for the super class.

Method Detail

getProperties

public List<Property> getProperties()

Gets all the exported properties.

writeTo

public void writeTo(T object,
                    DataWriter writer)
             throws IOException

Writes the property values of the given object to the writer.

Throws:

IOException

writeTo

public void writeTo(T object,
                    TreePruner pruner,
                    DataWriter writer)
             throws IOException

Writes the property values of the given object to the writer.

Parameters:

pruner - Controls which portion of the object graph will be sent to the writer.

Throws:

IOException

writeTo

@Deprecated
public void writeTo(T object,
                                int baseVisibility,
                                DataWriter writer)
                         throws IOException

Deprecated. as of 1.139

Writes the property values of the given object to the writer.

Parameters:

baseVisibility - This parameters controls how much data we'd be writing, by adding bias to the sub tree cutting. A property with visibility X will be written if the current depth Y and baseVisibility Z satisfies X + Z > Y. 0 is the normal value. Positive value means writing bigger tree, and negative value means writing smaller trees.

Throws:

IOException