org.nutz.lang.util

类 NutMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.nutz.lang.util.NutMap

所有已实现的接口:

Serializable, Cloneable, Map<String,Object>, NutBean

直接已知子类:

RelationObjectMap, ViewModel

public class NutMap
extends LinkedHashMap<String,Object>
implements NutBean

对于 LinkedHashMap 的一个友好封装

同 TreeMap 不同的是，如果 get(null)，它不会抛错，就是返回 null 或默认值

作者:

zozoh(zozohtnt@gmail.com)

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

从接口继承的嵌套类/接口 java.util.Map

Map.Entry<K,V>

构造器概要

构造器

构造器和说明
NutMap()
NutMap(Map<String,Object> map)
NutMap(String json)
NutMap(String key, Object value)

方法概要

限定符和类型	方法和说明
NutMap	addv(String key, Object value) 为 Map 增加一个名值对。
NutMap	attach(NutMap map)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
NutMap	detach()
NutMap	duplicate()
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
Object	get(String key, Object dft)
<T> T[]	getArray(String key, Class<T> eleType)
<T> T[]	getArray(String key, Class<T> eleType, T[] dft) 将一个字段转换成数组。
<T> T	getAs(String key, Class<T> classOfT)
<T> T	getAs(String key, Class<T> classOfT, T dft)
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean dft)
double	getDouble(String key)
double	getDouble(String key, double dft)
<T extends Enum<T>> T	getEnum(String key, Class<T> classOfEnum)
float	getFloat(String key)
float	getFloat(String key, float dft)
int	getInt(String key)
int	getInt(String key, int dft)
<T> List<T>	getList(String key, Class<T> eleType)
<T> List<T>	getList(String key, Class<T> eleType, List<T> dft) 将一个字段转换成列表。
long	getLong(String key)
long	getLong(String key, long dft)
<T> T	getOrBorn(String key, Borning<T> factory) 获取对应的值,若不存在,用factory创建一个,然后设置进去,返回之
String	getString(String key)
String	getString(String key, String dft)
Date	getTime(String key)
Date	getTime(String key, Date dft)
boolean	has(String key)
boolean	is(String key, Object val)
boolean	isEnum(String key, Enum<?>... eus)
Set<String>	keySet()
boolean	match(Map<String,Object> map) 将自身作为一个条件，看看给定的 Map 是否全部满足这个条件 注意，字符串型的值有下列意义 "^xxxxx" : 正则表达式 "" : 相当于 Blank
NutMap	mergeWith(Map<String,Object> map) 相当于 mergeWith(map, false)
NutMap	mergeWith(Map<String,Object> map, boolean onlyAbsent) 与一个给定的 Map 融合，如果有子 Map 递归
static NutMap	NEW()
NutMap	omit(String... keys) 从 Map 里将指定的键过滤，生成一个新的 Map
NutMap	pick(String... keys) 从 Map 里挑选一些键生成一个新的 Map
NutMap	pickAndRemove(String... keys) 从 Map 里挑选一些键生成一个新的 Map，自己同时删除这些键
NutMap	pickAndRemoveBy(Pattern p, boolean isNot) 从 Map 里挑选一些键生成一个新的 Map，自己同时删除这些键
NutMap	pickAndRemoveBy(String regex) 就是 pickAndRemoveBy 的一个便利写法
NutMap	pickBy(Pattern p, boolean isNot) 从 Map 里挑选一些键生成一个新的 Map
NutMap	pickBy(String regex) 从 Map 里挑选一些键生成一个新的 Map
NutMap	putDefault(String key, Object dft) 如果一个键的值无效（has(key) 返回 false)，那么为其设置默认值
NutMap	putv(String key, Object value) 已过时。 本函数意义容易发生混淆，已经改名成 addv，下个版将被删除
NutBean	setAll(Map<String,Object> map)
NutMap	setMap(Map<?,?> map, boolean ignoreNullValue)
NutMap	setnx(String key, Object val) 与JDK8+的 putIfAbsent(key, val)一致, 当且仅当值不存在时设置进去,但与putIfAbsent返回值有不一样
NutMap	setnxAll(Map<String,Object> map) 将一个集合与自己补充（相当于针对每个 key 调用 setnx)
void	setOrRemove(String key, Object v) 设置一个字段，如果值为 null 则表示移除
NutMap	setv(String key, Object value)
void	unset(String key)
Collection<Object>	values()
static NutMap	WRAP(Map<String,Object> map)
static NutMap	WRAP(String json)

从类继承的方法 java.util.LinkedHashMap

forEach, getOrDefault, removeEldestEntry, replaceAll

从类继承的方法 java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

从类继承的方法 java.util.AbstractMap

equals, hashCode, toString

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

构造器详细资料

NutMap

public NutMap()

NutMap

public NutMap(Map<String,Object> map)

NutMap

public NutMap(String json)

NutMap

public NutMap(String key,
              Object value)

方法详细资料

WRAP

public static NutMap WRAP(Map<String,Object> map)

setOrRemove

public void setOrRemove(String key,
                        Object v)

设置一个字段，如果值为 null 则表示移除

指定者:

setOrRemove 在接口中 NutBean

参数:

key - 键

v - 值

NEW

public static NutMap NEW()

WRAP

public static NutMap WRAP(String json)

has

public boolean has(String key)

指定者:

has 在接口中 NutBean

is

public boolean is(String key,
                  Object val)

指定者:

is 在接口中 NutBean

duplicate

public NutMap duplicate()

pick

public NutMap pick(String... keys)

从 Map 里挑选一些键生成一个新的 Map

指定者:

pick 在接口中 NutBean

参数:

keys - 键

返回:

新 Map

pickAndRemove

public NutMap pickAndRemove(String... keys)

从 Map 里挑选一些键生成一个新的 Map，自己同时删除这些键

指定者:

pickAndRemove 在接口中 NutBean

参数:

keys - 键

返回:

新 Map

pickBy

public NutMap pickBy(String regex)

从 Map 里挑选一些键生成一个新的 Map

指定者:

pickBy 在接口中 NutBean

参数:

regex - 匹配键的正则表达式，"!" 开头，表示取反

返回:

新 Map

pickBy

public NutMap pickBy(Pattern p,
                     boolean isNot)

从 Map 里挑选一些键生成一个新的 Map

指定者:

pickBy 在接口中 NutBean

参数:

p - 匹配键的正则表达式，null 不会匹配任何一个键

isNot - true 表示被匹配上的会被忽略，false 表示被匹配上的才加入到返回的集合里

返回:

新 Map

pickAndRemoveBy

public NutMap pickAndRemoveBy(String regex)

就是 pickAndRemoveBy 的一个便利写法

参数:

regex - 正则表达式，! 开头表示取反

返回:

新 Map

另请参阅:

pickAndRemoveBy(Pattern, boolean)

pickAndRemoveBy

public NutMap pickAndRemoveBy(Pattern p,
                              boolean isNot)

从 Map 里挑选一些键生成一个新的 Map，自己同时删除这些键

指定者:

pickAndRemoveBy 在接口中 NutBean

参数:

p - 匹配键的正则表达式，null 不会匹配任何一个键

isNot - true 表示被匹配上的会被忽略，false 表示被匹配上的才加入到返回的集合里

返回:

新 Map

omit

public NutMap omit(String... keys)

从 Map 里将指定的键过滤，生成一个新的 Map

指定者:

omit 在接口中 NutBean

参数:

keys - 键

返回:

新 Map

putDefault

public NutMap putDefault(String key,
                         Object dft)

如果一个键的值无效（has(key) 返回 false)，那么为其设置默认值

指定者:

putDefault 在接口中 NutBean

参数:

key - 键

dft - 值

返回:

自身以便链式赋值

containsValue

public boolean containsValue(Object value)

指定者:

containsValue 在接口中 Map<String,Object>

覆盖:

containsValue 在类中 LinkedHashMap<String,Object>

containsKey

public boolean containsKey(Object key)

指定者:

containsKey 在接口中 Map<String,Object>

覆盖:

containsKey 在类中 HashMap<String,Object>

keySet

public Set<String> keySet()

指定者:

keySet 在接口中 Map<String,Object>

覆盖:

keySet 在类中 LinkedHashMap<String,Object>

values

public Collection<Object> values()

指定者:

values 在接口中 Map<String,Object>

覆盖:

values 在类中 LinkedHashMap<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

指定者:

entrySet 在接口中 Map<String,Object>

覆盖:

entrySet 在类中 LinkedHashMap<String,Object>

clear

public void clear()

指定者:

clear 在接口中 Map<String,Object>

覆盖:

clear 在类中 LinkedHashMap<String,Object>

attach

public NutMap attach(NutMap map)

detach

public NutMap detach()

get

public Object get(Object key)

指定者:

get 在接口中 Map<String,Object>

覆盖:

get 在类中 LinkedHashMap<String,Object>

get

public Object get(String key,
                  Object dft)

指定者:

get 在接口中 NutBean

getInt

public int getInt(String key)

指定者:

getInt 在接口中 NutBean

getInt

public int getInt(String key,
                  int dft)

指定者:

getInt 在接口中 NutBean

getFloat

public float getFloat(String key)

指定者:

getFloat 在接口中 NutBean

getFloat

public float getFloat(String key,
                      float dft)

指定者:

getFloat 在接口中 NutBean

getLong

public long getLong(String key)

指定者:

getLong 在接口中 NutBean

getLong

public long getLong(String key,
                    long dft)

指定者:

getLong 在接口中 NutBean

getDouble

public double getDouble(String key)

指定者:

getDouble 在接口中 NutBean

getDouble

public double getDouble(String key,
                        double dft)

指定者:

getDouble 在接口中 NutBean

getBoolean

public boolean getBoolean(String key)

指定者:

getBoolean 在接口中 NutBean

getBoolean

public boolean getBoolean(String key,
                          boolean dft)

指定者:

getBoolean 在接口中 NutBean

getString

public String getString(String key)

指定者:

getString 在接口中 NutBean

getString

public String getString(String key,
                        String dft)

指定者:

getString 在接口中 NutBean

getTime

public Date getTime(String key)

指定者:

getTime 在接口中 NutBean

getTime

public Date getTime(String key,
                    Date dft)

指定者:

getTime 在接口中 NutBean

getEnum

public <T extends Enum<T>> T getEnum(String key,
                                     Class<T> classOfEnum)

指定者:

getEnum 在接口中 NutBean

isEnum

public boolean isEnum(String key,
                      Enum<?>... eus)

指定者:

isEnum 在接口中 NutBean

getAs

public <T> T getAs(String key,
                   Class<T> classOfT)

指定者:

getAs 在接口中 NutBean

getAs

public <T> T getAs(String key,
                   Class<T> classOfT,
                   T dft)

指定者:

getAs 在接口中 NutBean

getList

public <T> List<T> getList(String key,
                           Class<T> eleType)

指定者:

getList 在接口中 NutBean

另请参阅:

NutBean.getList(String, Class, List)

getList

public <T> List<T> getList(String key,
                           Class<T> eleType,
                           List<T> dft)

从接口复制的说明: NutBean

将一个字段转换成列表。因为返回的是容器，所以本函数永远不会返回 null

指定者:

getList 在接口中 NutBean

参数:

key - 键

eleType - 列表元素类型

dft - 默认值

返回:

列表对象，如果字段不存在或者为空，则返回一个空列表

getArray

public <T> T[] getArray(String key,
                        Class<T> eleType)

指定者:

getArray 在接口中 NutBean

另请参阅:

NutBean.getArray(String, Class, Object[])

getArray

public <T> T[] getArray(String key,
                        Class<T> eleType,
                        T[] dft)

从接口复制的说明: NutBean

将一个字段转换成数组。因为返回的是容器，所以本函数永远不会返回 null

指定者:

getArray 在接口中 NutBean

参数:

key - 键

eleType - 数组元素类型

dft - 默认值

返回:

数组对象，如果字段不存在或者为空，则返回一个空数组

addv

public NutMap addv(String key,
                   Object value)

为 Map 增加一个名值对。如果同名已经有值了，那么会将两个值合并成一个列表

指定者:

addv 在接口中 NutBean

参数:

key -

value -

putv

public NutMap putv(String key,
                   Object value)

已过时。 本函数意义容易发生混淆，已经改名成 addv，下个版将被删除

从以下版本开始:

1.b.51

setv

public NutMap setv(String key,
                   Object value)

指定者:

setv 在接口中 NutBean

unset

public void unset(String key)

指定者:

unset 在接口中 NutBean

setAll

public NutBean setAll(Map<String,Object> map)

指定者:

setAll 在接口中 NutBean

setMap

public NutMap setMap(Map<?,?> map,
                     boolean ignoreNullValue)

指定者:

setMap 在接口中 NutBean

mergeWith

public NutMap mergeWith(Map<String,Object> map)

相当于 mergeWith(map, false)

指定者:

mergeWith 在接口中 NutBean

另请参阅:

mergeWith(Map, boolean)

mergeWith

public NutMap mergeWith(Map<String,Object> map,
                        boolean onlyAbsent)

与一个给定的 Map 融合，如果有子 Map 递归

指定者:

mergeWith 在接口中 NutBean

参数:

map - 要合并进来的 Map

onlyAbsent - true 表示只有没有 key 才设置值

返回:

自身以便链式赋值

setnx

public NutMap setnx(String key,
                    Object val)

与JDK8+的 putIfAbsent(key, val)一致, 当且仅当值不存在时设置进去,但与putIfAbsent返回值有不一样

指定者:

setnx 在接口中 NutBean

参数:

key - 键

val - 值

返回:

当前的NutMap实例

setnxAll

public NutMap setnxAll(Map<String,Object> map)

将一个集合与自己补充（相当于针对每个 key 调用 setnx)

指定者:

setnxAll 在接口中 NutBean

参数:

map - 集合

返回:

自身

另请参阅:

setnx(String, Object)

getOrBorn

public <T> T getOrBorn(String key,
                       Borning<T> factory)

获取对应的值,若不存在,用factory创建一个,然后设置进去,返回之

指定者:

getOrBorn 在接口中 NutBean

参数:

key - 键

factory - 若不存在的话用于生成实例

返回:

已存在的值或新的值

match

public boolean match(Map<String,Object> map)

将自身作为一个条件，看看给定的 Map 是否全部满足这个条件

注意，字符串型的值有下列意义

• "^xxxxx" : 正则表达式
• "" : 相当于 Blank

指定者:

match 在接口中 NutBean

参数:

map - 给定的 Map

返回:

是否匹配