public class UserPropertyUtils
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
getDefaultValue(OfflineDBObjectProvider pro,
DBObject dbObj,
UserPropertyDefn upd)
Returns the default value of a User Property which could be from a registered
PropertyInitializer (or more likely UserPropertyInitializer )
or if no default value is provided by that mechanism, the default value defined
for the UserPropertyDefn . |
static java.util.List<UserPropertyDefn> |
getUserPropertydefns(OfflineDBObjectProvider prov,
DBObject dbobject)
get a list of the user property definitions for a DBObject
|
static java.util.List<UserPropertyDefn> |
getUserPropertydefns(OfflineDBObjectProvider prov,
java.lang.String type)
get a list of the user property definitions for a DBObject type
|
static java.util.Map<java.lang.String,java.lang.String> |
getUserpropertyNameValueMap(DBObject dbo)
get a List of the user property values for a DBObject
|
static java.lang.Object |
getValue(OfflineDBObjectProvider prov,
DBObject dbObject,
java.lang.String udpName)
Return the User Defined Property Value.
|
static void |
setValue(OfflineDBObjectProvider prov,
DBObject dbObject,
java.lang.String propName,
java.lang.Object propValue)
Sets the value of the given User defined property against the given DBObject.
|
static void |
setValues(OfflineDBObjectProvider prov,
DBObject dbObject,
java.util.Map<java.lang.String,java.lang.Object> values)
Sets the User defined properties defined in the map of name/value pairs
against the given DBObject.
|
public static java.util.Map<java.lang.String,java.lang.String> getUserpropertyNameValueMap(DBObject dbo)
public static java.util.List<UserPropertyDefn> getUserPropertydefns(OfflineDBObjectProvider prov, DBObject dbobject)
public static java.util.List<UserPropertyDefn> getUserPropertydefns(OfflineDBObjectProvider prov, java.lang.String type)
public static java.lang.Object getValue(OfflineDBObjectProvider prov, DBObject dbObject, java.lang.String udpName)
Get a user defined property value for a DBObject, given the provider, the object and the property name.
If the DBObject has a user defined property, return the value.
Otherwise,
get the user property Libraries from the provider,
search the libraries for a definiton of the property,
return the default value.
public static void setValue(OfflineDBObjectProvider prov, DBObject dbObject, java.lang.String propName, java.lang.Object propValue)
current default
for the property
it will not appear in the stored values.prov
- The providerdbObject
- The object against which to set the valuespropName
- The name of the User PropertypropValue
- The value of the User Propertypublic static void setValues(OfflineDBObjectProvider prov, DBObject dbObject, java.util.Map<java.lang.String,java.lang.Object> values)
current default
for the property will not appear in the stored values.prov
- The providerdbObject
- The object against which to set the valuesvalues
- A map of User Property name/value pairspublic static java.lang.String getDefaultValue(OfflineDBObjectProvider pro, DBObject dbObj, UserPropertyDefn upd)
PropertyInitializer
(or more likely UserPropertyInitializer
)
or if no default value is provided by that mechanism, the default value defined
for the UserPropertyDefn
.pro
- The providerdbObj
- The object for which the default value is soughtupd
- The definition of the property.