org.nuxeo.runtime.model

Interface Descriptor

All Known Implementing Classes:

AvroMapperDescriptor, AvroReplacementDescriptor, AvroSchemaDescriptor, AvroSchemaFactoryDescriptor, AWSConfigurationDescriptor, BatchHandlerDescriptor, BulkActionDescriptor, CacheDescriptor, CodecDescriptor, CodecDescriptor, ConfigurationPropertyDescriptor, DownloadPermissionDescriptor, KafkaConfigDescriptor, KeyValueStoreDescriptor, LogConfigDescriptor, LogConfigDescriptor.StreamDescriptor, LoginAsDescriptor, MarshallerDescriptor, MarshallerRegistryDescriptor, MigrationDescriptor, MigrationDescriptor.MigrationStateDescriptor, MigrationDescriptor.MigrationStepDescriptor, MongoDBConnectionConfig, PubSubProviderDescriptor, RedirectResolverDescriptor, RedisPoolDescriptor, RedisSentinelDescriptor, RedisSentinelDescriptor.RedisHostDescriptor, RedisServerDescriptor, RestBinding, StreamProcessorDescriptor, StreamProcessorDescriptor.ComputationDescriptor, StreamProcessorDescriptor.PolicyDescriptor, StreamProcessorDescriptor.StreamDescriptor, TransientStoreConfig, WorkQueueDescriptor, WorkQueuingDescriptor

public interface Descriptor

Descriptors implementing this interface will automatically be registered within the default registry in DefaultComponent.

Since:

10.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNIQUE_DESCRIPTOR_ID

Method Summary

Modifier and Type	Method and Description
default boolean	doesRemove() During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.
String	getId() The descriptor id, descriptors with same id are merged.
default Descriptor	merge(Descriptor other) Returns a descriptor representing other merged into this

Field Detail

UNIQUE_DESCRIPTOR_ID

static final String UNIQUE_DESCRIPTOR_ID

See Also:

Constant Field Values

Method Detail

getId

String getId()

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

merge

default Descriptor merge(Descriptor other)

Returns a descriptor representing other merged into this

Default implementation returns other.

Returns:

the merged descriptor

doesRemove

default boolean doesRemove()

During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.

If the last descriptor of same id doesRemove() return true, the descriptor for this id will be null.