java.lang.Object
- org.jenkinsci.plugins.structs.describable.UninstantiatedDescribable

All Implemented Interfaces:

Serializable
```
public class UninstantiatedDescribable
extends Object
implements Serializable
```
A reflection-like view of a particular Describable instance.

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ANONYMOUS_KEY`	As a short-hand, if a `DescribableModel` has only one required parameter, `instantiate(Class)` accepts a single-item map whose key is this magic token.

Constructor Summary

Constructors
Constructor	Description
`UninstantiatedDescribable(String symbol, String klass, Map<String,?> arguments)`
`UninstantiatedDescribable(Map<String,?> arguments)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`static UninstantiatedDescribable`	`from(Object o)`
`Map<String,?>`	`getArguments()`	All the nested arguments to this object.
`String`	`getKlass()`	"$class" is an alternative means to specify the class in case there's no symbol.
`DescribableModel`	`getModel()`	Returns the model associated with this object.
`String`	`getSymbol()`	If this nested describable has a suitable symbol name, this method returns one.
`int`	`hashCode()`
`boolean`	`hasSoleRequiredArgument()`	Returns true if and only if the arguments is one and that is the only required parameter from the model.
`Object`	`instantiate()`	Deprecated. instead use `instantiate(TaskListener)`
`Object`	`instantiate(TaskListener listener)`	Instantiates an actual `Describable` through the model, unless `klass` or `symbol` will be set to specify a specific type, in which case that takes a precedence.
`<T> T`	`instantiate(Class<T> base)`	Deprecated. instead use `instantiate(Class, TaskListener)`
`<T> T`	`instantiate(Class<T> base, TaskListener listener)`	Instantiates an actual `Describable` object from the specified arguments.
`void`	`setKlass(String klass)`
`void`	`setModel(DescribableModel model)`
`void`	`setSymbol(String symbol)`
`Map<String,Object>`	`toMap()`	For legacy use, we need to blow up this into a map form.
`Map<String,Object>`	`toShallowMap()`	Converts this `UninstantiatedDescribable` to a literal map expression without recursively doing so for children.
`String`	`toString()`	Debug assistance.
`UninstantiatedDescribable`	`withArguments(Map<String,?> arguments)`	Makes a copy of this struct with an alternate argument map.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ANONYMOUS_KEY
```
public static final String ANONYMOUS_KEY
```
    As a short-hand, if a DescribableModel has only one required parameter, instantiate(Class) accepts a single-item map whose key is this magic token.
    To avoid clients from needing to special-case this key, from(Object) does not produce arguments that contains this magic token. Clients who want to take advantages of this should look at DescribableModel.hasSingleRequiredParameter()
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UninstantiatedDescribable
```
public UninstantiatedDescribable(String symbol,
                                 String klass,
                                 Map<String,?> arguments)
```
  - UninstantiatedDescribable
```
public UninstantiatedDescribable(Map<String,?> arguments)
```
- Method Detail
  - withArguments
```
public UninstantiatedDescribable withArguments(Map<String,?> arguments)
```
    Makes a copy of this struct with an alternate argument map.
    
    Parameters:
    
    arguments - a replacement for getArguments()
    
    Returns:
    
    a new object with the same getSymbol(), getKlass(), and getModel()
  - getSymbol
```
@Nullable
public String getSymbol()
```
    If this nested describable has a suitable symbol name, this method returns one.
    Either this or getKlass() has to return a non-null value.
  - setSymbol
```
public void setSymbol(String symbol)
```
  - getKlass
```
@Nullable
public String getKlass()
```
    "$class" is an alternative means to specify the class in case there's no symbol. Can be a short name if it's contextually unambiguous, or a FQCN.
    Either this or getSymbol() has to return a non-null value.
  - setKlass
```
public void setKlass(String klass)
```
  - getModel
```
@CheckForNull
public DescribableModel getModel()
```
    Returns the model associated with this object. If this object was created from a model (via from(Object)) this method returns that model.
  - setModel
```
public void setModel(DescribableModel model)
```
  - getArguments
```
public Map<String,?> getArguments()
```
    All the nested arguments to this object.
  - hasSoleRequiredArgument
```
public boolean hasSoleRequiredArgument()
```
    Returns true if and only if the arguments is one and that is the only required parameter from the model.
    This usually signals a short-hand syntax to write down the instantiation syntax.
  - toMap
```
public Map<String,Object> toMap()
```
    For legacy use, we need to blow up this into a map form. This requires recursively blowing up any nested UninstantiatedDescribables.
  - toShallowMap
```
public Map<String,Object> toShallowMap()
```
    Converts this UninstantiatedDescribable to a literal map expression without recursively doing so for children.
  - instantiate
```
@Deprecated
public Object instantiate()
                   throws Exception
```
    Deprecated.
    instead use instantiate(TaskListener)
    
    Throws:
    
    Exception
  - instantiate
```
public Object instantiate(TaskListener listener)
                   throws Exception
```
    Instantiates an actual Describable through the model, unless klass or symbol will be set to specify a specific type, in which case that takes a precedence.
    
    Parameters:
    
    listener - Listener to record any instantiation warnings
    
    Returns:
    
    The instantiated object
    
    Throws:
    
    Exception
  - instantiate
```
@Deprecated
public <T> T instantiate(Class<T> base)
                  throws Exception
```
    Deprecated.
    instead use instantiate(Class, TaskListener)
    
    Throws:
    
    Exception
  - instantiate
```
public <T> T instantiate(Class<T> base,
                         TaskListener listener)
                  throws Exception
```
    Instantiates an actual Describable object from the specified arguments.
    
    Parameters:
    
    base - The expected type of the instance. The interpretation of the symbol and $class depends on this parameter.
    
    listener - Listener to record any instantiation warnings
    
    Returns:
    
    The instantiated object
    
    Throws:
    
    Exception
  - from
```
public static UninstantiatedDescribable from(Object o)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Debug assistance. The output might change.
    
    Overrides:
    
    toString in class Object

Class UninstantiatedDescribable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANONYMOUS_KEY

Constructor Detail

UninstantiatedDescribable

UninstantiatedDescribable

Method Detail

withArguments

getSymbol

setSymbol

getKlass

setKlass

getModel

setModel

getArguments

hasSoleRequiredArgument

toMap

toShallowMap

instantiate

instantiate

instantiate

instantiate

from

equals

hashCode

toString