Package jetbrains.buildServer.configs.dsl.extensions.param

Class KotlinDslDelegateParam

java.lang.Object

jetbrains.buildServer.configs.dsl.extensions.param.KotlinDslDelegateParam

All Implemented Interfaces:

KotlinDslParam

Direct Known Subclasses:

KotlinDslParamBoolean, KotlinDslParamCompound, KotlinDslParamEnum, KotlinDslParamInt, KotlinDslParamString

public abstract class KotlinDslDelegateParam
extends Object
implements KotlinDslParam

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.configs.dsl.extensions.param.KotlinDslParam

KotlinDslParam.Ref

Field Summary

Fields

Modifier and Type	Field	Description
protected DeprecatedInfo	myDeprecatedInfo
protected String	myDescription
protected String	myDslParamName
protected boolean	myMandatory
protected String	myXmlParamName
protected String	myYamlParamName

Constructor Summary

Constructors

Constructor	Description
KotlinDslDelegateParam(String dslParamName, String xmlParamName, String description, DeprecatedInfo deprecatedInfo, boolean mandatory)
KotlinDslDelegateParam(String dslParamName, String xmlParamName, String description, DeprecatedInfo deprecatedInfo, boolean mandatory, Map<String,String> additionalAttributes)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAdditionalAttributes()
DeprecatedInfo	getDeprecatedInfo()
String	getDescription()
String	getDslParamName()
String	getXmlParamName()
String	getYamlParamName()
int	hashCode()
protected boolean	hasSameNames(Object other)
boolean	isMandatory()
boolean	isStrictlyDeprecated()	Determines whether the KotlinDslParam was deprecated complitely or not.

Methods inherited from class java.lang.Object

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

Field Detail

myDslParamName

protected final String myDslParamName

myXmlParamName

protected final String myXmlParamName

myYamlParamName

protected final String myYamlParamName

myDescription

protected final String myDescription

myDeprecatedInfo

protected final DeprecatedInfo myDeprecatedInfo

myMandatory

protected final boolean myMandatory

Constructor Detail

KotlinDslDelegateParam

public KotlinDslDelegateParam(@NotNull
                              String dslParamName,
                              @NotNull
                              String xmlParamName,
                              @Nullable
                              String description,
                              @Nullable
                              DeprecatedInfo deprecatedInfo,
                              boolean mandatory)

KotlinDslDelegateParam

public KotlinDslDelegateParam(@NotNull
                              String dslParamName,
                              @NotNull
                              String xmlParamName,
                              @Nullable
                              String description,
                              @Nullable
                              DeprecatedInfo deprecatedInfo,
                              boolean mandatory,
                              @NotNull
                              Map<String,String> additionalAttributes)

Method Detail

getXmlParamName

@NotNull
public String getXmlParamName()

Specified by:

getXmlParamName in interface KotlinDslParam

getYamlParamName

public String getYamlParamName()

getDslParamName

@NotNull
public String getDslParamName()

isStrictlyDeprecated

public boolean isStrictlyDeprecated()

Description copied from interface: KotlinDslParam

Determines whether the KotlinDslParam was deprecated complitely or not. if true, it will not be commited in user DSL in typed form (param = ...), otherwise it will be commited but shown as deprecated. The property will be generated in DSL API anyway.

Specified by:

isStrictlyDeprecated in interface KotlinDslParam

Returns:

see above

isMandatory

public boolean isMandatory()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasSameNames

protected boolean hasSameNames(@NotNull
                               Object other)

getDescription

public String getDescription()

getDeprecatedInfo

public DeprecatedInfo getDeprecatedInfo()

getAdditionalAttributes

public Map<String,String> getAdditionalAttributes()