io.blueocean.rest.pipeline.editor

Class ExportedDescribableModel

java.lang.Object

io.blueocean.rest.pipeline.editor.ExportedDescribableModel

Direct Known Subclasses:

ExportedPipelineFunction

@ExportedBean
public class ExportedDescribableModel
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jenkinsci.plugins.structs.describable.DescribableModel<?>	model
protected String	symbol

Constructor Summary

Constructors

Constructor and Description
ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model)
ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model, String symbol)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Display Name of the describable class See DescribableModel.getDisplayName()
boolean	getHasSingleRequiredParameter() Whether this describable has one and only one parameter and it is required.
String	getHelp() Loads help defined for this object as a whole if available, else null.
List<ExportedDescribableParameter>	getParameters() Properties the describable supports See DescribableModel.getParameters()
String	getSymbol() Provides the symbol for this describable
String	getType() The Java class name for this describable (since we can't seem to export a Class<?> ...) See DescribableModel.getType()

Methods inherited from class java.lang.Object

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

Field Detail

model

protected final org.jenkinsci.plugins.structs.describable.DescribableModel<?> model

symbol

protected final String symbol

Constructor Detail

ExportedDescribableModel

public ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model)

ExportedDescribableModel

public ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model,
                        String symbol)

Method Detail

getType

@Exported
public String getType()

The Java class name for this describable (since we can't seem to export a Class<?> ...) See DescribableModel.getType()

getSymbol

@Exported
public String getSymbol()

Provides the symbol for this describable

Returns:

getDisplayName

@Exported
public String getDisplayName()

Display Name of the describable class See DescribableModel.getDisplayName()

getHasSingleRequiredParameter

@Exported
public boolean getHasSingleRequiredParameter()

Whether this describable has one and only one parameter and it is required. See DescribableModel.hasSingleRequiredParameter()

getHelp

@Exported
public String getHelp()
               throws IOException

Loads help defined for this object as a whole if available, else null. See DescribableModel.getHelp()

Throws:

IOException

getParameters

@Exported
public List<ExportedDescribableParameter> getParameters()

Properties the describable supports See DescribableModel.getParameters()