org.apache.flink.ml.api.misc.param

Class ParamInfoFactory.ParamInfoBuilder<V>

java.lang.Object

org.apache.flink.ml.api.misc.param.ParamInfoFactory.ParamInfoBuilder<V>

Type Parameters:

V - value type of the new ParamInfo

Enclosing class:

ParamInfoFactory

public static class ParamInfoFactory.ParamInfoBuilder<V>
extends Object

Builder to build a new ParamInfo. Builder is created by ParamInfoFactory with name and valueClass set.

Method Summary

Modifier and Type	Method and Description
ParamInfo<V>	build() Builds the defined ParamInfo and returns it.
ParamInfoFactory.ParamInfoBuilder<V>	setAlias(String[] alias) Sets the aliases of the parameter.
ParamInfoFactory.ParamInfoBuilder<V>	setDescription(String description) Sets the description of the parameter.
ParamInfoFactory.ParamInfoBuilder<V>	setHasDefaultValue(V defaultValue) Sets the flag indicating the parameter has default value, and sets the default value.
ParamInfoFactory.ParamInfoBuilder<V>	setOptional() Sets the flag indicating the parameter is optional.
ParamInfoFactory.ParamInfoBuilder<V>	setRequired() Sets the flag indicating the parameter is required.
ParamInfoFactory.ParamInfoBuilder<V>	setValidator(ParamValidator<V> validator) Sets the validator to validate the parameter value set by users.

Methods inherited from class java.lang.Object

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

Method Detail

setAlias

public ParamInfoFactory.ParamInfoBuilder<V> setAlias(String[] alias)

Sets the aliases of the parameter.

Returns:

the builder itself

setDescription

public ParamInfoFactory.ParamInfoBuilder<V> setDescription(String description)

Sets the description of the parameter.

Returns:

the builder itself

setOptional

public ParamInfoFactory.ParamInfoBuilder<V> setOptional()

Sets the flag indicating the parameter is optional. The parameter is optional by default.

Returns:

the builder itself

setRequired

public ParamInfoFactory.ParamInfoBuilder<V> setRequired()

Sets the flag indicating the parameter is required.

Returns:

the builder itself

setHasDefaultValue

public ParamInfoFactory.ParamInfoBuilder<V> setHasDefaultValue(V defaultValue)

Sets the flag indicating the parameter has default value, and sets the default value.

Returns:

the builder itself

setValidator

public ParamInfoFactory.ParamInfoBuilder<V> setValidator(ParamValidator<V> validator)

Sets the validator to validate the parameter value set by users.

Returns:

the builder itself

build

public ParamInfo<V> build()

Builds the defined ParamInfo and returns it. The ParamInfo will be immutable.

Returns:

the defined ParamInfo