Package org.jenkinsci.plugins.pipeline.utility.steps.conf

Class ReadYamlStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep

org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

org.jenkinsci.plugins.pipeline.utility.steps.conf.ReadYamlStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ReadYamlStep
extends AbstractFileOrTextStep

Reads a yaml file from the workspace.

Author:

Philippe GRANET <philippe.granet@gmail.com>.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadYamlStep.DescriptorImpl
static class	ReadYamlStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CODE_POINT_LIMIT_PROPERTY
static final String	DEFAULT_MAX_ALIASES_PROPERTY
static final int	HARDCODED_CEILING_MAX_ALIASES_FOR_COLLECTIONS
static final int	LIBRARY_DEFAULT_CODE_POINT_LIMIT
static final int	LIBRARY_DEFAULT_MAX_ALIASES_FOR_COLLECTIONS
static final String	MAX_CODE_POINT_LIMIT_PROPERTY
static final String	MAX_MAX_ALIASES_PROPERTY

Fields inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

text

Constructor Summary

Constructors

Constructor	Description
ReadYamlStep()

Method Summary

Modifier and Type	Method	Description
int	getCodePointLimit()
static int	getDefaultCodePointLimit()
static int	getDefaultMaxAliasesForCollections()
int	getMaxAliasesForCollections()
static int	getMaxCodePointLimit()
static int	getMaxMaxAliasesForCollections()
void	setCodePointLimit(int codePointLimit)
static int	setDefaultCodePointLimit(int defaultCodePointLimit)	Setter with an added check to ensure the default does not exceed the max value.
static int	setDefaultMaxAliasesForCollections(int defaultMaxAliasesForCollections)	Setter with an added check to ensure the default does not exceed the max value.
void	setMaxAliasesForCollections(int maxAliasesForCollections)
static int	setMaxMaxAliasesForCollections(int maxMaxAliasesForCollections)	Setter with an added check to ensure the default does not exceed the hardcoded max value.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileOrTextStep

getText, setText

Methods inherited from class org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileStep

getFile, setFile

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Field Details

LIBRARY_DEFAULT_CODE_POINT_LIMIT

public static final int LIBRARY_DEFAULT_CODE_POINT_LIMIT

MAX_CODE_POINT_LIMIT_PROPERTY

public static final String MAX_CODE_POINT_LIMIT_PROPERTY

DEFAULT_CODE_POINT_LIMIT_PROPERTY

public static final String DEFAULT_CODE_POINT_LIMIT_PROPERTY

HARDCODED_CEILING_MAX_ALIASES_FOR_COLLECTIONS

public static final int HARDCODED_CEILING_MAX_ALIASES_FOR_COLLECTIONS

See Also:

• Constant Field Values

LIBRARY_DEFAULT_MAX_ALIASES_FOR_COLLECTIONS

public static final int LIBRARY_DEFAULT_MAX_ALIASES_FOR_COLLECTIONS

MAX_MAX_ALIASES_PROPERTY

public static final String MAX_MAX_ALIASES_PROPERTY

DEFAULT_MAX_ALIASES_PROPERTY

public static final String DEFAULT_MAX_ALIASES_PROPERTY

Constructor Details

ReadYamlStep

@DataBoundConstructor
public ReadYamlStep()

Method Details

getMaxCodePointLimit

public static int getMaxCodePointLimit()

setDefaultCodePointLimit

public static int setDefaultCodePointLimit(int defaultCodePointLimit)

Setter with an added check to ensure the default does not exceed the max value.

Parameters:

defaultCodePointLimit - the default value to set.

Returns:

the actual value set after checking the max allowed.

getDefaultCodePointLimit

public static int getDefaultCodePointLimit()

setMaxMaxAliasesForCollections

public static int setMaxMaxAliasesForCollections(int maxMaxAliasesForCollections)

Setter with an added check to ensure the default does not exceed the hardcoded max value. TODO: decide if we want to add a message here before failing back.

Parameters:

maxMaxAliasesForCollections - maximum allowed aliases to be set.

Returns:

the resulting value after checking the ceiling.

getMaxMaxAliasesForCollections

public static int getMaxMaxAliasesForCollections()

setDefaultMaxAliasesForCollections

public static int setDefaultMaxAliasesForCollections(int defaultMaxAliasesForCollections)

Setter with an added check to ensure the default does not exceed the max value.

Parameters:

defaultMaxAliasesForCollections - the default value to set.

Returns:

the actual value set after checking the max allowed.

getDefaultMaxAliasesForCollections

public static int getDefaultMaxAliasesForCollections()

getCodePointLimit

public int getCodePointLimit()

setCodePointLimit

@DataBoundSetter
public void setCodePointLimit(int codePointLimit)

getMaxAliasesForCollections

public int getMaxAliasesForCollections()

setMaxAliasesForCollections

@DataBoundSetter
public void setMaxAliasesForCollections(int maxAliasesForCollections)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception