Ice::ValueFactoryManager Local Interface Reference

A value factory manager maintains a collection of value factories. More...

defined in <Ice/ValueFactory.ice>

local interface ValueFactoryManager { ... }

Operations
void	add (["swift:nonnull"] ValueFactory factory, ["objc:param:sliceId"] string id)
	Add a value factory. More...
ValueFactory	find (string id)
	Find an value factory registered with this communicator. More...

Detailed Description

A value factory manager maintains a collection of value factories.

An application can supply a custom implementation during communicator initialization, otherwise Ice provides a default implementation.

See also

ValueFactory

Operation Documentation

add()

void add	(	["swift:nonnull"] ValueFactory	factory,
		["objc:param:sliceId"] string	id
	)

Add a value factory.

Attempting to add a factory with an id for which a factory is already registered throws AlreadyRegisteredException.

When unmarshaling an Ice value, the Ice run time reads the most-derived type id off the wire and attempts to create an instance of the type using a factory. If no instance is created, either because no factory was found, or because all factories returned nil, the behavior of the Ice run time depends on the format with which the value was marshaled:

If the value uses the "sliced" format, Ice ascends the class hierarchy until it finds a type that is recognized by a factory, or it reaches the least-derived type. If no factory is found that can create an instance, the run time throws NoValueFactoryException.

If the value uses the "compact" format, Ice immediately raises NoValueFactoryException.

The following order is used to locate a factory for a type:

1. The Ice run-time looks for a factory registered specifically for the type.

2. If no instance has been created, the Ice run-time looks for the default factory, which is registered with an empty type id.

3. If no instance has been created by any of the preceding steps, the Ice run-time looks for a factory that may have been statically generated by the language mapping for non-abstract classes.

Parameters

factory	The factory to add.
id	The type id for which the factory can create instances, or an empty string for the default factory.

find()

["cpp:const","cpp:noexcept","swift:noexcept"]

ValueFactory find

(

string

id

)

Find an value factory registered with this communicator.

Parameters

id	The type id for which the factory can create instances, or an empty string for the default factory.

Returns

The value factory, or null if no value factory was found for the given id.

---

The documentation for this interface was generated from the following file:

• Ice/ValueFactory.ice