Package org.jenkinsci.plugins.workflow.structs

Class DescribableHelper

java.lang.Object

org.jenkinsci.plugins.workflow.structs.DescribableHelper

public class DescribableHelper
extends Object

Deprecated.

Moved to the structs plugin. See DescribableModel

Utility for converting between Describables (and some other objects) and map-like representations. Ultimately should live in Jenkins core (or Stapler).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DescribableHelper.ArrayType	Deprecated.
static final class	DescribableHelper.AtomicType	Deprecated.
static final class	DescribableHelper.EnumType	Deprecated.
static final class	DescribableHelper.ErrorType	Deprecated.
static final class	DescribableHelper.HeterogeneousObjectType	Deprecated. A parameter (or array element) which could take any of the indicated concrete object types.
static final class	DescribableHelper.HomogeneousObjectType	Deprecated.
static class	DescribableHelper.ParameterType	Deprecated. A type of a parameter to a class.
static final class	DescribableHelper.Schema	Deprecated. Definition of how a particular class may be configured.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLAZZ	Deprecated.

Method Summary

Modifier and Type	Method	Description
static <T> T	instantiate(Class<? extends T> clazz, Map<String,?> arguments)	Deprecated. Creates an instance of a class via DataBoundConstructor and DataBoundSetter.
static DescribableHelper.Schema	schemaFor(Class<?> clazz)	Deprecated. Loads a definition of the structure of a class: what kind of data you might get back from uninstantiate(java.lang.Object) on an instance, or might want to pass to instantiate(java.lang.Class<? extends T>, java.util.Map<java.lang.String, ?>).
static Map<String,Object>	uninstantiate(Object o)	Deprecated. Computes arguments suitable to pass to instantiate(java.lang.Class<? extends T>, java.util.Map<java.lang.String, ?>) to reconstruct this object.

Methods inherited from class java.lang.Object

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

Field Details

CLAZZ

public static final String CLAZZ

Deprecated.

See Also:

• Constant Field Values

Method Details

instantiate

public static <T> T instantiate(Class<? extends T> clazz,
 Map<String,?> arguments)
                         throws Exception

Deprecated.

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 static Map<String,Object> uninstantiate(Object o)
                                        throws UnsupportedOperationException

Deprecated.

Computes arguments suitable to pass to instantiate(java.lang.Class<? extends T>, 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

schemaFor

public static DescribableHelper.Schema schemaFor(Class<?> clazz)

Deprecated.

Loads a definition of the structure of a class: what kind of data you might get back from uninstantiate(java.lang.Object) on an instance, or might want to pass to instantiate(java.lang.Class<? extends T>, java.util.Map<java.lang.String, ?>).