at.favre.lib.armadillo

Class Armadillo

java.lang.Object

at.favre.lib.armadillo.Armadillo

public final class Armadillo
extends java.lang.Object

The main API of this library.

Since:

26.12.2017

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Armadillo.Builder Builder pattern for creating the configuration for an ArmadilloSharedPreferences instance

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_KEY_OUT_BYTE_LENGTH
static int	DEFAULT_PROTOCOL_VERSION
static int	KITKAT_PROTOCOL_VERSION

Method Summary

Modifier and Type	Method and Description
static Armadillo.Builder	create(android.content.Context context, java.lang.String preferenceName) Create a new builder for Armadillo.
static Armadillo.Builder	create(android.content.SharedPreferences sharedPreferences) Create a new instance of the builder with a custom implementation of shared preference.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_KEY_OUT_BYTE_LENGTH

public static final int CONTENT_KEY_OUT_BYTE_LENGTH

See Also:

Constant Field Values

DEFAULT_PROTOCOL_VERSION

public static final int DEFAULT_PROTOCOL_VERSION

See Also:

Constant Field Values

KITKAT_PROTOCOL_VERSION

public static final int KITKAT_PROTOCOL_VERSION

See Also:

Constant Field Values

Method Detail

create

public static Armadillo.Builder create(android.content.SharedPreferences sharedPreferences)

Create a new instance of the builder with a custom implementation of shared preference. If you want to omit the default behaviour how Armadillo sets up a SharedPreferences instance, use this create. This is also useful for testing purposes.

Note that this is a more advanced feature and usually you want the default implementation with create(Context, String).

Parameters:

sharedPreferences - to use as backing persistence layer

Returns:

builder

create

public static Armadillo.Builder create(android.content.Context context,
                                       java.lang.String preferenceName)

Create a new builder for Armadillo. Will internally create a SharedPreferences from given context. Pass the preference name (think of database name), which is unique to your persistence layer (e.g. if you create with the same preference name you will get the old stored values).

This name will be used to derive the file name used to store the shared preference xml on disk (read: it will be hashed, not directly used).

Parameters:

context - to get shared preference and other Android OS specific data

preferenceName - to identify the persistence store

Returns:

builder