KeyValueStoreDescriptor (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.runtime.kv.KeyValueStoreDescriptor

All Implemented Interfaces:

Descriptor
```
public class KeyValueStoreDescriptor
extends Object
implements Descriptor
```
Descriptor of Key/Value store contribution.

Since:

9.1

Field Summary

Fields
Modifier and Type	Field	Description
`Class<? extends KeyValueStoreProvider>`	`klass`
`String`	`name`
`String`	`namespace`	An optional namespace that may be used to disambiguate otherwise similar descriptors (in particular, copies).
`Map<String,String>`	`properties`
`boolean`	`remove`

Fields inherited from interface org.nuxeo.runtime.model.Descriptor
UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors
Constructor Description

KeyValueStoreDescriptor()
Empty constructor.

KeyValueStoreDescriptor(KeyValueStoreDescriptor other)
Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getId()
The descriptor id, descriptors with same id are merged.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.nuxeo.runtime.model.Descriptor
  doesRemove, merge

- Field Detail
  - name
```
public String name
```
  - remove
```
public boolean remove
```
  - klass
```
public Class<? extends KeyValueStoreProvider> klass
```
  - namespace
```
public String namespace
```
    An optional namespace that may be used to disambiguate otherwise similar descriptors (in particular, copies).
    
    Since:
    
    10.10
  - properties
```
public Map<String,String> properties
```
- Constructor Detail
  - KeyValueStoreDescriptor
```
public KeyValueStoreDescriptor()
```
    Empty constructor.
  - KeyValueStoreDescriptor
```
public KeyValueStoreDescriptor(KeyValueStoreDescriptor other)
```
    Copy constructor.
    
    Since:
    
    10.10
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: Descriptor
    
    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.
    
    Specified by:
    
    getId in interface Descriptor