org.kohsuke.stapler.export

Class Property

java.lang.Object

org.kohsuke.stapler.export.Property

All Implemented Interfaces:

java.lang.Comparable<Property>

public abstract class Property
extends java.lang.Object
implements java.lang.Comparable<Property>

Exposes one exposed property of ExportedBean to DataWriter.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Property that)
abstract java.lang.reflect.Type	getGenericType()
abstract java.lang.String	getJavadoc() Gets the associated javadoc, if any, or null.
abstract java.lang.Class	getType()
protected abstract java.lang.Object	getValue(java.lang.Object bean) Gets the value of this property from the bean.
void	writeTo(java.lang.Object object, int depth, DataWriter writer) Deprecated. as of 1.139
void	writeTo(java.lang.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 Detail

name

public final java.lang.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()

Method Detail

compareTo

public int compareTo(Property that)

Specified by:

compareTo in interface java.lang.Comparable<Property>

getGenericType

public abstract java.lang.reflect.Type getGenericType()

getType

public abstract java.lang.Class getType()

getJavadoc

public abstract java.lang.String getJavadoc()

Gets the associated javadoc, if any, or null.

writeTo

public void writeTo(java.lang.Object object,
           TreePruner pruner,
           DataWriter writer)
             throws java.io.IOException

Writes one property of the given object to DataWriter.

Parameters:

pruner - Determines how to prune the object graph tree.

Throws:

java.io.IOException

writeTo

public void writeTo(java.lang.Object object,
           int depth,
           DataWriter writer)
             throws java.io.IOException

Deprecated. as of 1.139

Throws:

java.io.IOException

getValue

protected abstract java.lang.Object getValue(java.lang.Object bean)
                                      throws java.lang.IllegalAccessException,
                                             java.lang.reflect.InvocationTargetException

Gets the value of this property from the bean.

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException