enterprises.orbital.base

Class PersistentProperty

java.lang.Object

enterprises.orbital.base.PersistentProperty

public class PersistentProperty
extends Object

Simple persistent key-value store. This class is similar to Java Properties except that values may be backed by a persistent property provider. The default provider is in-memory, which is not persistent at all and adds little value over simply using OrbitalProperties (or Properties directly). However, by substituting a provider which persists data, you can use properties which persist between sessions. For convenience, this class is also designed to work with a key generator for arbitrary classes called PersistentPropertyKey. This class allows you to map arbitrary objects to string keys, perhaps associated with a particular name space. See README.md for an example.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentProperty.InMemoryPersistentPropertyProvider Default provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	propertyName Property name.
protected String	propertyValue
protected static PersistentPropertyProvider	provider By default, we provide an in-memory "persistent" provider.

Constructor Summary

Constructors

Constructor and Description
PersistentProperty()
PersistentProperty(String propertyName, String propertyValue)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static List<PersistentProperty>	getAll()
static <B,A extends PersistentPropertyKey<B>> boolean	getBooleanPropertyWithFallback(A ns, B key)
static <B,A extends PersistentPropertyKey<B>> boolean	getBooleanPropertyWithFallback(A ns, B key, boolean def)
static boolean	getBooleanPropertyWithFallback(String key)
static boolean	getBooleanPropertyWithFallback(String key, boolean def)
static <B,A extends PersistentPropertyKey<B>> int	getIntegerPropertyWithFallback(A ns, B key)
static <B,A extends PersistentPropertyKey<B>> int	getIntegerPropertyWithFallback(A ns, B key, int def)
static int	getIntegerPropertyWithFallback(String key)
static int	getIntegerPropertyWithFallback(String key, int def)
static <B,A extends PersistentPropertyKey<B>> long	getLongPropertyWithFallback(A ns, B key)
static <B,A extends PersistentPropertyKey<B>> long	getLongPropertyWithFallback(A ns, B key, long def)
static long	getLongPropertyWithFallback(String key)
static long	getLongPropertyWithFallback(String key, long def)
static <B,A extends PersistentPropertyKey<B>> String	getProperty(A ns, B key)
static <B,A extends PersistentPropertyKey<B>> String	getProperty(A ns, B key, String defValue)
static String	getProperty(String key)
static String	getProperty(String key, String defValue)
String	getPropertyName()
String	getPropertyValue()
static <B,A extends PersistentPropertyKey<B>> String	getPropertyWithFallback(A ns, B key)
static <B,A extends PersistentPropertyKey<B>> String	getPropertyWithFallback(A ns, B key, String def)
static String	getPropertyWithFallback(String key)
static String	getPropertyWithFallback(String key, String def)
int	hashCode()
static <B,A extends PersistentPropertyKey<B>> String	removeProperty(A ns, B key)
static String	removeProperty(String key)
static <B,A extends PersistentPropertyKey<B>> String	setProperty(A ns, B key, String value)
static String	setProperty(String key, String value)
static void	setProvider(PersistentPropertyProvider p)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

provider

protected static PersistentPropertyProvider provider

By default, we provide an in-memory "persistent" provider. You'll want to replace this if you actually want properties to persist between instances. You'll want to change the provider as one of the first init actions taken.

propertyName

protected String propertyName

Property name. This should also be the unique ID for this value when stored.

propertyValue

protected String propertyValue

Constructor Detail

PersistentProperty

public PersistentProperty()

PersistentProperty

public PersistentProperty(String propertyName,
                          String propertyValue)

Method Detail

setProvider

public static void setProvider(PersistentPropertyProvider p)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPropertyName

public String getPropertyName()

getPropertyValue

public String getPropertyValue()

getProperty

public static String getProperty(String key,
                                 String defValue)

getProperty

public static <B,A extends PersistentPropertyKey<B>> String getProperty(A ns,
                                                                        B key,
                                                                        String defValue)

getAll

public static List<PersistentProperty> getAll()

getProperty

public static String getProperty(String key)
                          throws NoPersistentPropertyException

Throws:

NoPersistentPropertyException

getProperty

public static <B,A extends PersistentPropertyKey<B>> String getProperty(A ns,
                                                                        B key)
                                                                 throws NoPersistentPropertyException

Throws:

NoPersistentPropertyException

setProperty

public static String setProperty(String key,
                                 String value)

setProperty

public static <B,A extends PersistentPropertyKey<B>> String setProperty(A ns,
                                                                        B key,
                                                                        String value)

removeProperty

public static String removeProperty(String key)

removeProperty

public static <B,A extends PersistentPropertyKey<B>> String removeProperty(A ns,
                                                                           B key)

getPropertyWithFallback

public static String getPropertyWithFallback(String key)

getPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> String getPropertyWithFallback(A ns,
                                                                                    B key)

getPropertyWithFallback

public static String getPropertyWithFallback(String key,
                                             String def)

getPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> String getPropertyWithFallback(A ns,
                                                                                    B key,
                                                                                    String def)

getBooleanPropertyWithFallback

public static boolean getBooleanPropertyWithFallback(String key)

getBooleanPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> boolean getBooleanPropertyWithFallback(A ns,
                                                                                            B key)

getBooleanPropertyWithFallback

public static boolean getBooleanPropertyWithFallback(String key,
                                                     boolean def)

getBooleanPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> boolean getBooleanPropertyWithFallback(A ns,
                                                                                            B key,
                                                                                            boolean def)

getLongPropertyWithFallback

public static long getLongPropertyWithFallback(String key)

getLongPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> long getLongPropertyWithFallback(A ns,
                                                                                      B key)

getLongPropertyWithFallback

public static long getLongPropertyWithFallback(String key,
                                               long def)

getLongPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> long getLongPropertyWithFallback(A ns,
                                                                                      B key,
                                                                                      long def)

getIntegerPropertyWithFallback

public static int getIntegerPropertyWithFallback(String key)

getIntegerPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> int getIntegerPropertyWithFallback(A ns,
                                                                                        B key)

getIntegerPropertyWithFallback

public static int getIntegerPropertyWithFallback(String key,
                                                 int def)

getIntegerPropertyWithFallback

public static <B,A extends PersistentPropertyKey<B>> int getIntegerPropertyWithFallback(A ns,
                                                                                        B key,
                                                                                        int def)