org.jenkinsci.plugins.structs.describable

Class DescribableModel<T>

java.lang.Object

org.jenkinsci.plugins.structs.describable.DescribableModel<T>

public final class DescribableModel<T>
extends Object

Introspects a Describable with DataBoundConstructor and DataBoundSetter.

Provides such operations like

• instantiate this class from a JSON-like map
• take an existing instance and produces a JSON-like map that can be then fed back to the above instantiation call
• enumerate parameters of this Describable that are defined either through DataBoundConstructor or DataBoundSetter. See DescribableParameter for more details
• access help file

Note that some structures are recursive or mutually recursive. It is up a caller to defend against stack overflows when traversing a model graph, for example by keeping a stack of types which have already been encountered.

Author:

Jesse Glick, Andrew Bayer, Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLAZZ

Constructor Summary

Constructors

Constructor and Description
DescribableModel(Class<T> clazz) Loads a definition of the structure of a class: what kind of data you might get back from uninstantiate(T) on an instance, or might want to pass to instantiate(Map).

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Corresponds to Descriptor.getDisplayName() where available.
String	getHelp() Loads help defined for this object as a whole
DescribableParameter	getParameter(String name)
Collection<DescribableParameter>	getParameters() A map from parameter names to types.
Class<T>	getType() A concrete class, usually Describable.
T	instantiate(Map<String,?> arguments) Creates an instance of a class via DataBoundConstructor and DataBoundSetter.
String	toString()
static Map<String,Object>	uninstantiate_(Object o) In case if you just need to uninstantiate one object and be done with it.
Map<String,Object>	uninstantiate(T o) Computes arguments suitable to pass to instantiate(java.util.Map<java.lang.String, ?>) to reconstruct this object.

Methods inherited from class java.lang.Object

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

Field Detail

CLAZZ

public static final String CLAZZ

See Also:

Constant Field Values

Constructor Detail

DescribableModel

public DescribableModel(Class<T> clazz)

Loads a definition of the structure of a class: what kind of data you might get back from uninstantiate(T) on an instance, or might want to pass to instantiate(Map).

Method Detail

getType

public Class<T> getType()

A concrete class, usually Describable.

getParameters

public Collection<DescribableParameter> getParameters()

A map from parameter names to types. A parameter name is either the name of an argument to a DataBoundConstructor, or the JavaBeans property name corresponding to a DataBoundSetter.

Sorted by the mandatory parameters first (in the order they are specified in the code), followed by optional arguments.

getParameter

public DescribableParameter getParameter(String name)

getDisplayName

public String getDisplayName()

Corresponds to Descriptor.getDisplayName() where available.

instantiate

public T instantiate(Map<String,?> arguments)
              throws Exception

Creates an instance of a class via DataBoundConstructor and DataBoundSetter.

The arguments may be primitives (as wrappers) or Strings if that is their declared type. Characters, Enums, and URLs may be represented by Strings. Other object types may be passed in “raw” as well, but JSON-like structures are encouraged instead. Specifically a List may be used to represent any list- or array-valued argument. A Map with String keys may be used to represent any class which is itself data-bound. In that case the special key CLAZZ is used to specify the Class.getName(); or it may be omitted if the argument is declared to take a concrete type; or Class.getSimpleName() may be used in case the argument type is Describable and only one subtype is registered (as a Descriptor) with that simple name.

Throws:

Exception

uninstantiate

public Map<String,Object> uninstantiate(T o)
                                 throws UnsupportedOperationException

Computes arguments suitable to pass to instantiate(java.util.Map<java.lang.String, ?>) to reconstruct this object.

Parameters:

o - a data-bound object

Returns:

constructor and/or setter parameters

Throws:

UnsupportedOperationException - if the class does not follow the expected structure

uninstantiate_

public static Map<String,Object> uninstantiate_(Object o)

In case if you just need to uninstantiate one object and be done with it.

getHelp

@CheckForNull
public String getHelp()
               throws IOException

Loads help defined for this object as a whole

Returns:

some HTML (in English locale), if available, else null

Throws:

IOException

See Also:

Descriptor.doHelp(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)

toString

public String toString()

Overrides:

toString in class Object