com.hazelcast.instance

Class HazelcastProperties

java.lang.Object

com.hazelcast.instance.HazelcastProperties

Direct Known Subclasses:

ClientProperties, GroupProperties

public abstract class HazelcastProperties
extends Object

Container for configured Hazelcast properties (HazelcastProperty).

A HazelcastProperty can be set as:

• an environmental variable using System.setProperty(String, String)
• the programmatic configuration using Config.setProperty(String, String)
• the XML configuration http://docs.hazelcast.org/docs/latest-dev/manual/html-single/hazelcast-documentation.html#system-properties

Constructor Summary

Constructors

Constructor and Description
HazelcastProperties()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String[]	createProperties() Created the properties array.
boolean	getBoolean(HazelcastProperty groupProperty) Returns the configured boolean value of a HazelcastProperty.
<E extends Enum> E	getEnum(GroupProperty groupProperty, Class<E> enumClazz) Returns the configured enum value of a GroupProperty.
float	getFloat(HazelcastProperty groupProperty) Returns the configured float value of a HazelcastProperty.
int	getInteger(HazelcastProperty groupProperty) Returns the configured int value of a HazelcastProperty.
long	getLong(HazelcastProperty groupProperty) Returns the configured long value of a HazelcastProperty.
long	getMillis(HazelcastProperty groupProperty) Returns the configured value of a HazelcastProperty converted to milliseconds.
long	getNanos(HazelcastProperty groupProperty) Returns the configured value of a HazelcastProperty converted to nanoseconds.
int	getSeconds(HazelcastProperty groupProperty) Returns the configured value of a HazelcastProperty converted to seconds.
String	getString(HazelcastProperty groupProperty) Returns the configured value of a HazelcastProperty as String.
protected void	initProperties(Properties properties, HazelcastProperty[] hazelcastProperties) Creates a container with configured Hazelcast properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

HazelcastProperties

public HazelcastProperties()

Method Detail

createProperties

protected abstract String[] createProperties()

Created the properties array.

Returns:

a String array with the size of the properties.

initProperties

protected void initProperties(Properties properties,
                  HazelcastProperty[] hazelcastProperties)

Creates a container with configured Hazelcast properties.

Uses the environmental value if no value is defined in the configuration. Uses the default value if no environmental value is defined.

Parameters:

properties - Properties used to configure the HazelcastProperty values.

hazelcastProperties - array of HazelcastProperty to configure

getString

public String getString(HazelcastProperty groupProperty)

Returns the configured value of a HazelcastProperty as String.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value or null if nothing has been configured

getBoolean

public boolean getBoolean(HazelcastProperty groupProperty)

Returns the configured boolean value of a HazelcastProperty.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value as boolean

getInteger

public int getInteger(HazelcastProperty groupProperty)

Returns the configured int value of a HazelcastProperty.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value as int

Throws:

NumberFormatException - if the value cannot be parsed

getLong

public long getLong(HazelcastProperty groupProperty)

Returns the configured long value of a HazelcastProperty.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value as long

Throws:

NumberFormatException - if the value cannot be parsed

getFloat

public float getFloat(HazelcastProperty groupProperty)

Returns the configured float value of a HazelcastProperty.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value as float

Throws:

NumberFormatException - if the value cannot be parsed

getNanos

public long getNanos(HazelcastProperty groupProperty)

Returns the configured value of a HazelcastProperty converted to nanoseconds.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value in nanoseconds

Throws:

IllegalArgumentException - if the HazelcastProperty has no TimeUnit

getMillis

public long getMillis(HazelcastProperty groupProperty)

Returns the configured value of a HazelcastProperty converted to milliseconds.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value in milliseconds

Throws:

IllegalArgumentException - if the HazelcastProperty has no TimeUnit

getSeconds

public int getSeconds(HazelcastProperty groupProperty)

Returns the configured value of a HazelcastProperty converted to seconds.

Parameters:

groupProperty - the HazelcastProperty to get the value from

Returns:

the value in seconds

Throws:

IllegalArgumentException - if the HazelcastProperty has no TimeUnit

getEnum

public <E extends Enum> E getEnum(GroupProperty groupProperty,
                         Class<E> enumClazz)

Returns the configured enum value of a GroupProperty.

The case of the enum is ignored.

Parameters:

groupProperty - the GroupProperty to get the value from

Returns:

the enum

Throws:

IllegalArgumentException - if the enum value can't be found