Package jetbrains.buildServer.util

Interface OptionSupport

All Known Subinterfaces:

BuildDependency, BuildDependencyEx, BuildTypeEx, BuildTypeOptions, BuildTypeSettings, BuildTypeSettingsEx, BuildTypeTemplate, BuildTypeTemplateEx, Dependency, DependencyOptions, OptionSupportEx, RemoteBuildType, RemoteBuildTypeEx, SBuildType

All Known Implementing Classes:

BuildDependencyImpl, BuildTypeImpl, BuildTypeSettingsImpl, BuildTypeTemplateImpl, DependencyImpl, DependencyOptionSupportImpl, DummyBuildType, EditableBuildTypeCopy, EditableTemplateCopy, EmptyOptionSupport, InaccessibleTemplate, MockBuildType, OptionSupportAdapter, RemoteBuildTypeImpl, SecuredBuildType, SecuredBuildTypeTemplate, UnresolvedDependency

public interface OptionSupport

This interface provides basic support for options of various types. It allows to set and retrieve options.

See Also:

Option

Method Summary

Modifier and Type	Method	Description
Option[]	getChangedOptions()	Return options with changed values, i.e.
<T> T	getDeclaredOption(Option<T> option)	Get option value declared in this BuildTypeSettings
<T> T	getOption(Option<T> option)	Get option value
<T> T	getOptionDefaultValue(Option<T> option)
Collection<Option>	getOptions()
Collection<Option>	getOwnOptions()	Return options defined in this object, i.e.
<T> void	setOption(Option<T> option, T value)	Set option value, clears value if it is the same as default

Method Detail

setOption

<T> void setOption(@NotNull
                   Option<T> option,
                   @NotNull
                   T value)

Set option value, clears value if it is the same as default

Parameters:

option - option to set value for

value - option value

getOwnOptions

@NotNull
Collection<Option> getOwnOptions()

Return options defined in this object, i.e. options for which some value has been set using setOption(Option, Object) method.

Returns:

see above

Since:

8.1

getOptions

@NotNull
Collection<Option> getOptions()

Returns:

combined set of options - own and inherited

Since:

8.1

getChangedOptions

@NotNull
Option[] getChangedOptions()

Return options with changed values, i.e. options with non-default values

Returns:

see above

getOption

@NotNull
<T> T getOption(@NotNull
                Option<T> option)

Get option value

Parameters:

option - option to retrieve value for

Returns:

value of the option. If value wasn't set, Option:getDefaultValue is returned

getOptionDefaultValue

@NotNull
<T> T getOptionDefaultValue(@NotNull
                            Option<T> option)

Parameters:

option - option whose default value to return

Returns:

default value for specified option

Since:

8.1

getDeclaredOption

@Nullable
<T> T getDeclaredOption(Option<T> option)

Get option value declared in this BuildTypeSettings

Parameters:

option - option to retrieve value for

Returns:

value of the option. If value wasn't set, null is returned

Since:

10.0