Package io.jenkins.plugins.casc.model

Interface CNode

All Superinterfaces:

Cloneable

All Known Implementing Classes:

Mapping, Scalar, Sequence

public interface CNode
extends Cloneable

A configuration Node in yaml tree. (We didn't used Node as class name to avoid collision with commonly used Jenkins class hudson.model.Node

Author:

Nicolas De Loof

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CNode.Type

Method Summary

Modifier and Type	Method	Description
default Mapping	asMapping()
default Scalar	asScalar()
default Sequence	asSequence()
CNode	clone()
Source	getSource()	Indicate the source (file, line number) this specific configuration node comes from.
CNode.Type	getType()
default boolean	isPrintableWhenEmpty()	Indicates if the field should be included when describing even if empty
default boolean	isSensitiveData()	Deprecated. sensitive data are identified based on target attribute being a $Secret

Method Details

getType

CNode.Type getType()

asMapping

default Mapping asMapping()
                   throws ConfiguratorException

Throws:

ConfiguratorException

asSequence

default Sequence asSequence()
                     throws ConfiguratorException

Throws:

ConfiguratorException

asScalar

default Scalar asScalar()
                 throws ConfiguratorException

Throws:

ConfiguratorException

isSensitiveData

@Deprecated
default boolean isSensitiveData()

Deprecated.

sensitive data are identified based on target attribute being a $Secret

isPrintableWhenEmpty

default boolean isPrintableWhenEmpty()

Indicates if the field should be included when describing even if empty

Returns:

false by default

getSource

Source getSource()

Indicate the source (file, line number) this specific configuration node comes from. This is used to offer relevant diagnostic messages

clone

CNode clone()