com.hazelcast.config

Class MapAttributeConfig

java.lang.Object

com.hazelcast.config.MapAttributeConfig

Direct Known Subclasses:

MapAttributeConfigReadOnly

public class MapAttributeConfig
extends Object

Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor. This class should be used in combination with the MapConfig.

See Also:

ValueExtractor

Constructor Summary

Constructors

Constructor and Description
MapAttributeConfig() Creates an empty MapAttributeConfig.
MapAttributeConfig(MapAttributeConfig config)
MapAttributeConfig(String name, String extractor) Creates a MapAttributeConfig with the given attribute and ordered setting.

Method Summary

Modifier and Type	Method and Description
MapAttributeConfigReadOnly	getAsReadOnly() Deprecated. this method will be removed in 4.0; it is meant for internal usage only.
String	getExtractor() Gets the full class name of the extractor in a String format, e.g.
String	getName() Gets the name of the attribute extracted by the extractor.
MapAttributeConfig	setExtractor(String extractor) Sets the full class name of the extractor in a String format, e.g.
MapAttributeConfig	setName(String name) Sets the name of the attribute extracted by the extractor.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MapAttributeConfig

public MapAttributeConfig()

Creates an empty MapAttributeConfig.

MapAttributeConfig

public MapAttributeConfig(String name,
                          String extractor)

Creates a MapAttributeConfig with the given attribute and ordered setting. Name may begin with an ascii letter [A-Za-z] or digit [0-9] and may contain ascii letters [A-Za-z], digits [0-9] or underscores later on.

Parameters:

name - the name given to an attribute that is going to be extracted.

extractor - full class name of the extractor used to extract the value of the attribute.

See Also:

setName(String), setExtractor(String)

MapAttributeConfig

public MapAttributeConfig(MapAttributeConfig config)

Method Detail

getAsReadOnly

public MapAttributeConfigReadOnly getAsReadOnly()

Deprecated. this method will be removed in 4.0; it is meant for internal usage only.

Gets immutable version of this configuration.

Returns:

Immutable version of this configuration.

getName

public String getName()

Gets the name of the attribute extracted by the extractor.

Returns:

the name of the attribute extracted by the extractor.

See Also:

setName(String)

setName

public MapAttributeConfig setName(String name)

Sets the name of the attribute extracted by the extractor. The name cannot be equal to any of the query constants.

Parameters:

name - the name of the attribute extracted by the extractor.

Returns:

the updated MapAttributeConfig.

Throws:

IllegalArgumentException - if attribute is null,an empty or inappropriate string.

See Also:

QueryConstants

getExtractor

public String getExtractor()

Gets the full class name of the extractor in a String format, e.g. com.example.car.SpeedExtractor

Returns:

the full class name of the extractor in a String format.

See Also:

setExtractor(String)

setExtractor

public MapAttributeConfig setExtractor(String extractor)

Sets the full class name of the extractor in a String format, e.g. com.example.car.SpeedExtractor

Parameters:

extractor - the full class name of the extractor in a String format.

Returns:

the updated MapAttributeConfig.

toString

public String toString()

Overrides:

toString in class Object