org.linguafranca.pwdb.security

Class VariantDictionary

java.lang.Object

org.linguafranca.pwdb.security.VariantDictionary

public class VariantDictionary
extends Object

Implementation of a storage for V4 KDBX Header field parameters

Though specific to KDBX V4 it is kept here for convenience of parameter passing to crypto functions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariantDictionary.Entry
static class	VariantDictionary.EntryType The list of permissible entry types

Constructor Summary

Constructors

Constructor and Description
VariantDictionary(short version) Make a new Variant Dictionary whose version must be 1

Method Summary

Modifier and Type	Method and Description
VariantDictionary	copy() Make a copy of this structure - Entries are immutable so are copied as is
@Nullable VariantDictionary.Entry	get(@NotNull String key) Return an entry for the key supplied
Map<String,VariantDictionary.Entry>	getEntries() get the entries in this dictionary
short	getVersion() Get the version number of this structure
@NotNull VariantDictionary.Entry	mustGet(@NotNull String key) ensure that the entry sought is not null, by throwing an illegal argument exception if it is not present
void	put(@NotNull String key, VariantDictionary.EntryType type, byte[] value) Add an entry of the type defined
void	putByteArray(@NotNull String key, byte[] value) Put a byte array under the key defined
void	putInt(@NotNull String key, int value)
void	putLong(@NotNull String key, long value) Put a long as a signed64 under the key defined
void	putUInt(@NotNull String key, int value)
void	putULong(@NotNull String key, long value) Put a long as an unsigned64 under the key defined
void	putUuid(@NotNull String key, UUID uuid) Put a UUID under the key defined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VariantDictionary

public VariantDictionary(short version)

Make a new Variant Dictionary whose version must be 1

Method Detail

copy

public VariantDictionary copy()

Make a copy of this structure - Entries are immutable so are copied as is

getEntries

public Map<String,VariantDictionary.Entry> getEntries()

get the entries in this dictionary

getVersion

public short getVersion()

Get the version number of this structure

Returns:

1

get

@Nullable
public @Nullable VariantDictionary.Entry get(@NotNull
                                                       @NotNull String key)

Return an entry for the key supplied

Parameters:

key - the key

Returns:

an entry, or null if no such entry exists

mustGet

@NotNull
public @NotNull VariantDictionary.Entry mustGet(@NotNull
                                                         @NotNull String key)

ensure that the entry sought is not null, by throwing an illegal argument exception if it is not present

Parameters:

key - the key to get

Returns:

the entry corresponding to the key

put

public void put(@NotNull
                @NotNull String key,
                VariantDictionary.EntryType type,
                byte[] value)

Add an entry of the type defined

Parameters:

key - the entry key

type - the data type of the entry

value - a buffer containing an appropriate entry

putUuid

public void putUuid(@NotNull
                    @NotNull String key,
                    UUID uuid)

Put a UUID under the key defined

putByteArray

public void putByteArray(@NotNull
                         @NotNull String key,
                         byte[] value)

Put a byte array under the key defined

putLong

public void putLong(@NotNull
                    @NotNull String key,
                    long value)

Put a long as a signed64 under the key defined

putULong

public void putULong(@NotNull
                     @NotNull String key,
                     long value)

Put a long as an unsigned64 under the key defined

putInt

public void putInt(@NotNull
                   @NotNull String key,
                   int value)

putUInt

public void putUInt(@NotNull
                    @NotNull String key,
                    int value)