StoreKey (ambry-api 0.3.442 API)

java.lang.Object
- com.github.ambry.store.StoreKey

All Implemented Interfaces:

java.lang.Comparable<StoreKey>
```
public abstract class StoreKey
extends java.lang.Object
implements java.lang.Comparable<StoreKey>
```
Represents the index key. To make an object part of an index key, this interface can be implemented

Constructor Summary

Constructors
Constructor Description

StoreKey()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`getID()`	Get the key in String form
`abstract java.lang.String`	`getLongForm()`	Get a long form of the key for printing.
`abstract byte[]`	`getUuidBytesArray()`	The byte version of UUID for this key
`abstract boolean`	`isAccountContainerMatch(short accountId, short containerId)`
`abstract short`	`sizeInBytes()`	The size of the serialized version of the key
`abstract byte[]`	`toBytes()`	The byte version of this key

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - StoreKey
```
public StoreKey()
```
- Method Detail
  - toBytes
```
public abstract byte[] toBytes()
```
    The byte version of this key
    
    Returns:
    
    A byte buffer that represents the key
  - getUuidBytesArray
```
public abstract byte[] getUuidBytesArray()
```
    The byte version of UUID for this key
    
    Returns:
    
    A byte buffer that represents the UUID of this key
  - sizeInBytes
```
public abstract short sizeInBytes()
```
    The size of the serialized version of the key
    
    Returns:
    
    The size of the key
  - getID
```
public abstract java.lang.String getID()
```
    Get the key in String form
    
    Returns:
    
    the key in String form
  - isAccountContainerMatch
```
public abstract boolean isAccountContainerMatch(short accountId,
                                                short containerId)
```
    Returns:
    
    true if accountId and containerId in key match given accountId and containerId from store.
  - getLongForm
```
public abstract java.lang.String getLongForm()
```
    Get a long form of the key for printing.
    
    Returns:
    
    the long form of the key