Package org.kohsuke.stapler.export

Class Property

java.lang.Object

org.kohsuke.stapler.export.Property

All Implemented Interfaces:

Comparable<Property>

public abstract class Property
extends Object
implements Comparable<Property>

Exposes one exposed property of ExportedBean to DataWriter.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	inline
final boolean	merge
final String	name	Name of the property.
final Model	parent	Model to which this property belongs to.
final int	visibility	Visibility depth level of this property.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Property that)
abstract Type	getGenericType()
abstract String	getJavadoc()	Gets the associated javadoc, if any, or null.
abstract Class	getType()
abstract Object	getValue(Object bean)	Gets the value of this property from the bean.
void	writeTo(Object object, int depth, DataWriter writer)	Deprecated. as of 1.139
void	writeTo(Object object, TreePruner pruner, DataWriter writer)	Writes one property of the given object to DataWriter.

Methods inherited from class java.lang.Object

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

Field Details

name

public final String name

Name of the property.

visibility

public final int visibility

Visibility depth level of this property.

See Also:

• Exported.visibility()

parent

public final Model parent

Model to which this property belongs to. Never null.

inline

public final boolean inline

See Also:

• Exported.inline()

merge

public final boolean merge

See Also:

• Exported.merge()

Method Details

compareTo

public int compareTo(Property that)

Specified by:

compareTo in interface Comparable<Property>

getGenericType

public abstract Type getGenericType()

getType

public abstract Class getType()

getJavadoc

public abstract String getJavadoc()

Gets the associated javadoc, if any, or null.

writeTo

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

Writes one property of the given object to DataWriter.

Parameters:

pruner - Determines how to prune the object graph tree.

Throws:

IOException

writeTo

@Deprecated
public void writeTo(Object object,
 int depth,
 DataWriter writer)
             throws IOException

Deprecated.

as of 1.139

Throws:

IOException

getValue

public abstract Object getValue(Object bean)
                         throws IllegalAccessException,
InvocationTargetException

Gets the value of this property from the bean.

Throws:

IllegalAccessException

InvocationTargetException