com.hazelcast.config

Class DataLinkConfig

java.lang.Object

com.hazelcast.config.DataLinkConfig

All Implemented Interfaces:

NamedConfig, DataSerializable, IdentifiedDataSerializable

@Beta
public class DataLinkConfig
extends Object
implements IdentifiedDataSerializable, NamedConfig

A configuration of a data link that can be used:

• to create a source or sink in a Jet Pipeline,
• as a data link for MapStore and MapLoader,
• to create an SQL mapping.

Since:

5.3

Constructor Summary

Constructors

Constructor and Description
DataLinkConfig()
DataLinkConfig(DataLinkConfig config)
DataLinkConfig(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getClassId() Returns type identifier for this class.
String	getClassName() Returns the name of the DataLink implementation class
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
String	getName() Returns the name of this data link.
Properties	getProperties() Returns all the properties of a data link
String	getProperty(String key) Returns a single property of a data link
int	hashCode()
boolean	isShared() true if an instance of the data link will be reused.
void	readData(ObjectDataInput in) Reads fields from the input stream
DataLinkConfig	setClassName(String className) Sets the name for the DataLink implementation class
DataLinkConfig	setName(String name) Sets the name of this data link, the name must be unique.
DataLinkConfig	setProperties(Properties properties) Sets the properties of a data link.
DataLinkConfig	setProperty(String key, String value) Sets a single property.
DataLinkConfig	setShared(boolean shared) true if an instance of the data link will be reused.
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataLinkConfig

public DataLinkConfig()

DataLinkConfig

public DataLinkConfig(DataLinkConfig config)

DataLinkConfig

public DataLinkConfig(String name)

Method Detail

setName

public DataLinkConfig setName(String name)

Sets the name of this data link, the name must be unique.

Specified by:

setName in interface NamedConfig

Returns:

this DataLinkConfig

getName

public String getName()

Returns the name of this data link.

Specified by:

getName in interface NamedConfig

Returns:

the name of this data link

getClassName

public String getClassName()

Returns the name of the DataLink implementation class

setClassName

public DataLinkConfig setClassName(@Nonnull
                                   String className)

Sets the name for the DataLink implementation class

isShared

public boolean isShared()

true if an instance of the data link will be reused. false when on each usage the data link instance should be created. The default is true

Returns:

if the data link instance should be reused

setShared

public DataLinkConfig setShared(boolean shared)

true if an instance of the data link will be reused. false when on each usage the data link instance should be created

Parameters:

shared - if the data link instance should be reused

Returns:

this DataLinkConfig

getProperties

public Properties getProperties()

Returns all the properties of a data link

Returns:

all the properties of a data link

getProperty

@Nullable
public String getProperty(String key)

Returns a single property of a data link

Parameters:

key - the property key of a data link

Returns:

property value or null if the given key doesn't exist

setProperty

public DataLinkConfig setProperty(String key,
                                  String value)

Sets a single property. See setProperties(Properties)

Parameters:

key - the property key

value - the property value

Returns:

this DataLinkConfig

setProperties

public DataLinkConfig setProperties(Properties properties)

Sets the properties of a data link. See implementations of DataLink for supported values

Parameters:

properties - the properties to be set

Returns:

this DataLinkConfig

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID