PrimitiveSet

java.lang.Object
- com.google.crypto.tink.PrimitiveSet<P>

```
public final class PrimitiveSet<P>
extends Object
```
A container class for a set of primitives -- implementations of cryptographic primitives offered by Tink.
It provides also additional properties for the primitives it holds. In particular, one of the primitives in the set can be distinguished as "the primary" one.
PrimitiveSet is an auxiliary class used for supporting key rotation: primitives in a set correspond to keys in a keyset. Users will usually work with primitive instances, which essentially wrap primitive sets. For example an instance of an Aead-primitive for a given keyset holds a set of Aead-primitives corresponding to the keys in the keyset, and uses the set members to do the actual crypto operations: to encrypt data the primary Aead-primitive from the set is used, and upon decryption the ciphertext's prefix determines the id of the primitive from the set.
PrimitiveSet is a public class to allow its use in implementations of custom primitives.

Since:

1.0.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PrimitiveSet.Builder<P>` Builds an immutable PrimitiveSet.
`static class`	`PrimitiveSet.Entry<P>` A single entry in the set.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PrimitiveSet.Entry<P>`	`addPrimitive(P primitive, Keyset.Key key)` Deprecated. use `Builder.addPrimitive` or `Builder.addPrimaryPrimitive` instead.
`Collection<List<PrimitiveSet.Entry<P>>>`	`getAll()`
`MonitoringAnnotations`	`getAnnotations()`
`PrimitiveSet.Entry<P>`	`getPrimary()` Returns the entry with the primary primitive.
`List<PrimitiveSet.Entry<P>>`	`getPrimitive(byte[] identifier)`
`Class<P>`	`getPrimitiveClass()`
`List<PrimitiveSet.Entry<P>>`	`getRawPrimitives()`
`boolean`	`hasAnnotations()`
`static <P> PrimitiveSet.Builder<P>`	`newBuilder(Class<P> primitiveClass)`
`static <P> PrimitiveSet<P>`	`newPrimitiveSet(Class<P> primitiveClass)` Deprecated. use `PrimitiveSet.Builder` instead.
`void`	`setPrimary(PrimitiveSet.Entry<P> primary)` Deprecated. use `Builder.addPrimaryPrimitive` instead.

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

Method Detail

getPrimary

@Nullable
public PrimitiveSet.Entry<P> getPrimary()

Returns the entry with the primary primitive.

hasAnnotations
```
public boolean hasAnnotations()
```

getAnnotations

public MonitoringAnnotations getAnnotations()

getRawPrimitives

public List<PrimitiveSet.Entry<P>> getRawPrimitives()

Returns:: all primitives using RAW prefix.

getPrimitive

public List<PrimitiveSet.Entry<P>> getPrimitive(byte[] identifier)

Returns:: the entries with primitive identifed by identifier.

getAll

public Collection<List<PrimitiveSet.Entry<P>>> getAll()

Returns:: all primitives

newPrimitiveSet

@Deprecated
public static <P> PrimitiveSet<P> newPrimitiveSet(Class<P> primitiveClass)

Deprecated. use PrimitiveSet.Builder instead.

Creates a new mutable PrimitiveSet.

setPrimary
```
@Deprecated
public void setPrimary(PrimitiveSet.Entry<P> primary)
```
Deprecated. use Builder.addPrimaryPrimitive instead.

Sets given Entry primary as the primary one.

Throws:

IllegalStateException - if object has been created by the PrimitiveSet.Builder.

addPrimitive

@Deprecated
 @CanIgnoreReturnValue
public PrimitiveSet.Entry<P> addPrimitive(P primitive,
                                                                             Keyset.Key key)
                                                                      throws GeneralSecurityException

Deprecated. use Builder.addPrimitive or Builder.addPrimaryPrimitive instead.

Creates an entry in the primitive table.

Returns:: the added PrimitiveSet.Entry
Throws:: IllegalStateException - if object has been created by the PrimitiveSet.Builder.; GeneralSecurityException

getPrimitiveClass
```
public Class<P> getPrimitiveClass()
```

newBuilder

public static <P> PrimitiveSet.Builder<P> newBuilder(Class<P> primitiveClass)

Class PrimitiveSet<P>