public class

PropertyKey

extends Object
java.lang.Object
   ↳ org.apache.helix.PropertyKey

Class Overview

Key allowing for type-safe lookups of and conversions to HelixProperty objects.

Summary

Nested Classes
class PropertyKey.Builder PropertyKey builder for a cluster  
Fields
public PropertyType _type
Public Constructors
PropertyKey(PropertyType type, Class<? extends HelixProperty> typeClazz, String... params)
Instantiate with a type, associated class, and parameters
PropertyKey(PropertyType type, HelixConfigScope.ConfigScopeProperty configScope, Class<? extends HelixProperty> typeClazz, String... params)
Instantiate with a type, scope, associated class, and parameters
Public Methods
HelixConfigScope.ConfigScopeProperty getConfigScope()
Get the scope of this property
String[] getParams()
Get parameters associated with the key
String getPath()
Get the path associated with this property
PropertyType getType()
Get the associated property type
Class<? extends HelixProperty> getTypeClass()
Get the associated class of this property
int hashCode()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public PropertyType _type

Public Constructors

public PropertyKey (PropertyType type, Class<? extends HelixProperty> typeClazz, String... params)

Instantiate with a type, associated class, and parameters

Parameters
params parameters associated with the key, the first of which is the cluster name

public PropertyKey (PropertyType type, HelixConfigScope.ConfigScopeProperty configScope, Class<? extends HelixProperty> typeClazz, String... params)

Instantiate with a type, scope, associated class, and parameters

Parameters
params parameters associated with the key, the first of which is the cluster name

Public Methods

public HelixConfigScope.ConfigScopeProperty getConfigScope ()

Get the scope of this property

Returns

public String[] getParams ()

Get parameters associated with the key

Returns
  • the parameters in the same order they were provided

public String getPath ()

Get the path associated with this property

Returns
  • absolute path to the property

public PropertyType getType ()

Get the associated property type

Returns

public Class<? extends HelixProperty> getTypeClass ()

Get the associated class of this property

Returns

public int hashCode ()

public String toString ()