InMemoryPropertySelection (storage-engine-adapter-api 2.6.0 API)

public interface InMemoryPropertySelection

Field Summary

Fields
Modifier and Type Field Description

static InMemoryPropertySelection SELECT_ALL

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isKeysOnly()`	A hint that the creator of this selection isn't interested in the actual values, only the existence of the keys.
`boolean`	`isLimited()`
`int`	`key(int index)`
`int`	`numberOfKeys()`
`boolean`	`test(int key)`

- Field Detail
  - SELECT_ALL
```
static final InMemoryPropertySelection SELECT_ALL
```
- Method Detail
  - isLimited
```
boolean isLimited()
```
    Returns:
    
    true if this selection limits which keys will be selected, otherwise false if all will be selected.
  - numberOfKeys
```
int numberOfKeys()
```
    Returns:
    
    the number of keys in this selection. If the selection is not limited 1 is returned 1 and with the key TokenConstants.ANY_PROPERTY_KEY from a call to key(0).
  - key
```
int key(int index)
```
    Parameters:
    
    index - the selection index. A selection can have multiple keys.
    
    Returns:
    
    the key for the given selection index.
  - test
```
boolean test(int key)
```
    Parameters:
    
    key - the key to tests whether or not it fits the criteria of this selection.
    
    Returns:
    
    true if the given key is part of this selection, otherwise false.
  - isKeysOnly
```
boolean isKeysOnly()
```
    A hint that the creator of this selection isn't interested in the actual values, only the existence of the keys.
    
    Returns:
    
    true if only keys will be extracted where this selection is used, otherwise false if also values will be extracted.