PartitionKeyMetaData (OfficeFloor 3.33.0 API)

java.lang.Object
- net.officefloor.nosql.cosmosdb.PartitionKeyMetaData

public class PartitionKeyMetaData
extends java.lang.Object

Meta-data for the PartitionKey.

Author:: Daniel Sagenschneider

Field Summary

Fields
Modifier and Type	Field	Description
`static PartitionKeyMetaData`	`DEFAULT`	Default `PartitionKeyMetaData` being the identifier of the entity.
`static java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey>`	`DEFAULT_FACTORY`	Default `PartitionKey` factory that uses the entity's identifier.

Constructor Summary

Constructors
Constructor	Description
`PartitionKeyMetaData(java.lang.String path, java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey> factory)`	Instantiate.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey>`	`getFactory()`	Obtains the factory to create `PartitionKey` from entity.
`static PartitionKeyMetaData`	`getPartitionKeyMetaData(java.lang.Class<?> entityType)`	Obtains the `PartitionKeyMetaData` for the entity type.
`java.lang.String`	`getPath()`	Obtains the `PartitionKey` path.

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

- Field Detail
  - DEFAULT_FACTORY
```
public static final java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey> DEFAULT_FACTORY
```
    Default PartitionKey factory that uses the entity's identifier.
  - DEFAULT
```
public static final PartitionKeyMetaData DEFAULT
```
    Default PartitionKeyMetaData being the identifier of the entity.
- Constructor Detail
  - PartitionKeyMetaData
```
public PartitionKeyMetaData(java.lang.String path,
                            java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey> factory)
```
    Instantiate.
    
    Parameters:
    
    path - PartitionKey path.
    
    factory - Factory to create PartitionKey from entity.
- Method Detail
  - getPartitionKeyMetaData
```
public static PartitionKeyMetaData getPartitionKeyMetaData(java.lang.Class<?> entityType)
```
    Obtains the PartitionKeyMetaData for the entity type.
    
    Parameters:
    
    entityType - Entity type.
    
    Returns:
    
    PartitionKeyMetaData for the entity type.
  - getPath
```
public java.lang.String getPath()
```
    Obtains the PartitionKey path.
    
    Returns:
    
    PartitionKey path.
  - getFactory
```
public java.util.function.Function<java.lang.Object,com.azure.cosmos.models.PartitionKey> getFactory()
```
    Obtains the factory to create PartitionKey from entity.
    
    Returns:
    
    Factory to create PartitionKey from entity.