Package jetbrains.buildServer.configs.dsl.extensions

Class DslAddOn

java.lang.Object

jetbrains.buildServer.configs.dsl.extensions.DslAddOn

All Implemented Interfaces:

Comparable<DslAddOn>

public class DslAddOn
extends Object
implements Comparable<DslAddOn>

Extends other dsl extensions. Used as mixin.

This is a DTO class parsed from XML file.

Example XML file:

 <dsl-add-on kind="buildStep">
   <extends>
     <dsl type="Ant"/>
   </extends>
   <params>
     <param name="param.name" dslName="theDslName" type="string">
       <description>The param description</description>
     </param>
   </params>
   <!-- Other params... -->
   <types>
     <enum name="EnumNameInPascalCase">
       <description> Enum description </description>
       <option name="Any" value=""/>
       <option name="Linux" value="linux"/>
       <!-- Other enum options... -->
     </enum>
   </types>
 </dsl-add-on>
 

Constructor Summary

Constructors

Constructor	Description
DslAddOn(String name, ExtensionKind kind, List<DslAddOnExtension> extensions, List<KotlinDslParam> params, List<KotlinDslEnum> enums)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DslAddOn o)
List<KotlinDslEnum>	getEnums()	Returns enums this add-on adds to other extensions
Set<String>	getExtensionTypes()	Returns types of dsl extensions this add-on modifies
ExtensionKind	getKind()	Returns kind of dsl extensions this add-on extends
List<KotlinDslParam>	getParams()	Returns parameters this add-on adds to other extensions
boolean	isApplicable(String dslExtensionType, String dslExtensionPredicate)

Methods inherited from class java.lang.Object

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

Constructor Detail

DslAddOn

public DslAddOn(@Nullable
                String name,
                @NotNull
                ExtensionKind kind,
                @NotNull
                List<DslAddOnExtension> extensions,
                @NotNull
                List<KotlinDslParam> params,
                @NotNull
                List<KotlinDslEnum> enums)

Method Detail

getKind

@NotNull
public ExtensionKind getKind()

Returns kind of dsl extensions this add-on extends

Returns:

see above

getExtensionTypes

@NotNull
public Set<String> getExtensionTypes()

Returns types of dsl extensions this add-on modifies

Returns:

see above

getParams

@NotNull
public List<KotlinDslParam> getParams()

Returns parameters this add-on adds to other extensions

Returns:

see above

getEnums

@NotNull
public List<KotlinDslEnum> getEnums()

Returns enums this add-on adds to other extensions

Returns:

see above

isApplicable

public boolean isApplicable(@NotNull
                            String dslExtensionType,
                            @Nullable
                            String dslExtensionPredicate)

compareTo

public int compareTo(@NotNull
                     DslAddOn o)

Specified by:

compareTo in interface Comparable<DslAddOn>