alluxio

Class PropertyKey.Builder

java.lang.Object

alluxio.PropertyKey.Builder

Enclosing class:

PropertyKey

public static final class PropertyKey.Builder
extends Object

Builder to create PropertyKey instances. Note that, Builder.build() will throw exception if there is an existing property built with the same name.

Constructor Summary

Constructors

Constructor and Description
Builder(PropertyKey.Template template, Object... params)
Builder(String name)

Method Summary

Modifier and Type	Method and Description
PropertyKey	build() Creates and registers the property key.
PropertyKey	buildUnregistered() Creates the property key without registering it with default property list.
PropertyKey.Builder	setAlias(String[] alias)
PropertyKey.Builder	setConsistencyCheckLevel(PropertyKey.ConsistencyCheckLevel consistencyCheckLevel)
PropertyKey.Builder	setDefaultSupplier(DefaultSupplier defaultSupplier)
PropertyKey.Builder	setDefaultSupplier(java.util.function.Supplier<Object> supplier, String description)
PropertyKey.Builder	setDefaultValue(Object defaultValue)
PropertyKey.Builder	setDescription(String description)
PropertyKey.Builder	setDisplayType(PropertyKey.DisplayType displayType)
PropertyKey.Builder	setIgnoredSiteProperty(boolean ignoredSiteProperty)
PropertyKey.Builder	setIsBuiltIn(boolean isBuiltIn)
PropertyKey.Builder	setIsHidden(boolean isHidden)
PropertyKey.Builder	setName(String name)
PropertyKey.Builder	setScope(Scope scope)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name)

Parameters:

name - name of the property

Builder

public Builder(PropertyKey.Template template,
               Object... params)

Parameters:

template - template for the property name

params - parameters of the template

Method Detail

setAlias

public PropertyKey.Builder setAlias(String[] alias)

Parameters:

alias - aliases for the property

Returns:

the updated builder instance

setName

public PropertyKey.Builder setName(String name)

Parameters:

name - name for the property

Returns:

the updated builder instance

setDefaultSupplier

public PropertyKey.Builder setDefaultSupplier(DefaultSupplier defaultSupplier)

Parameters:

defaultSupplier - supplier for the property's default value

Returns:

the updated builder instance

setDefaultSupplier

public PropertyKey.Builder setDefaultSupplier(java.util.function.Supplier<Object> supplier,
                                              String description)

Parameters:

supplier - supplier for the property's default value

description - description of the default value

Returns:

the updated builder instance

setDefaultValue

public PropertyKey.Builder setDefaultValue(Object defaultValue)

Parameters:

defaultValue - the property's default value

Returns:

the updated builder instance

setDescription

public PropertyKey.Builder setDescription(String description)

Parameters:

description - of the property

Returns:

the updated builder instance

setIsBuiltIn

public PropertyKey.Builder setIsBuiltIn(boolean isBuiltIn)

Parameters:

isBuiltIn - whether to the property is a built-in Alluxio property

Returns:

the updated builder instance

setIsHidden

public PropertyKey.Builder setIsHidden(boolean isHidden)

Parameters:

isHidden - whether to hide the property when generating property documentation

Returns:

the updated builder instance

setIgnoredSiteProperty

public PropertyKey.Builder setIgnoredSiteProperty(boolean ignoredSiteProperty)

Parameters:

ignoredSiteProperty - whether the property should be ignored in alluxio-site.properties

Returns:

the updated builder instance

setConsistencyCheckLevel

public PropertyKey.Builder setConsistencyCheckLevel(PropertyKey.ConsistencyCheckLevel consistencyCheckLevel)

Parameters:

consistencyCheckLevel - the consistency level that applies to this property

Returns:

the updated builder instance

setScope

public PropertyKey.Builder setScope(Scope scope)

Parameters:

scope - which components this property applies to

Returns:

the updated builder instance

setDisplayType

public PropertyKey.Builder setDisplayType(PropertyKey.DisplayType displayType)

Parameters:

displayType - the displayType that indicates how the property value should be displayed

Returns:

the updated builder instance

build

public PropertyKey build()

Creates and registers the property key.

Returns:

the created property key instance

buildUnregistered

public PropertyKey buildUnregistered()

Creates the property key without registering it with default property list.

Returns:

the created property key instance

toString

public String toString()

Overrides:

toString in class Object