org.apache.solr.common.util

类 NamedList<T>

java.lang.Object

org.apache.solr.common.util.NamedList<T>

所有已实现的接口:

Serializable, Cloneable, Iterable<Map.Entry<String,T>>, SimpleMap<T>, MapSerializable, MapWriter, NavigableObject

直接已知子类:

BaseCloudSolrClient.RouteResponse, SimpleOrderedMap

public class NamedList<T>
extends Object
implements Cloneable, Serializable, Iterable<Map.Entry<String,T>>, MapWriter, SimpleMap<T>

A simple container class for modeling an ordered list of name/value pairs.

Unlike Maps:

• Names may be repeated
• Order of elements is maintained
• Elements may be accessed by numeric index
• Names and Values can both be null

A NamedList provides fast access by element number, but not by name.

When a NamedList is serialized, order is considered more important than access by key, so ResponseWriters that output to a format such as JSON will normally choose a data structure that allows order to be easily preserved in various clients (i.e. not a straight map). If access by key is more important for serialization, see SimpleOrderedMap, or simply use a regular Map

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	NamedList.NamedListEntry<T> Helper class implementing Map.Entry<String, T> to store the key-value relationship in NamedList (the keys of which are String-s)

从接口继承的嵌套类/接口 org.apache.solr.common.MapWriter

MapWriter.EntryWriter

字段概要

字段

限定符和类型	字段和说明
protected List<Object>	nvPairs

构造器概要

构造器

构造器和说明
NamedList() Creates an empty instance
NamedList(int sz)
NamedList(Map.Entry<String,? extends T>[] nameValuePairs) Creates a NamedList instance containing the "name,value" pairs contained in the Entry[].
NamedList(Map<String,? extends T> nameValueMap) Creates a NamedList instance containing the "name,value" pairs contained in the Map.

方法概要

限定符和类型	方法和说明
int	_size()
void	abortableForEach(BiFunction<String,? super T,Boolean> fun) Navigate through all key-values but abort in between if required.
void	abortableForEachKey(Function<String,Boolean> fun) iterate through all keys but abort in between if required The default impl is suboptimal.
void	add(String name, T val) Adds a name/value pair to the end of the list.
boolean	addAll(Map<String,T> args) Iterates over the Map and sequentially adds its key/value pairs
boolean	addAll(NamedList<T> nl) Appends the elements of the given NamedList to this one.
Map	asMap(int maxDepth)
Map<String,T>	asShallowMap()
Map<String,T>	asShallowMap(boolean allowDps)
void	clear()
NamedList<T>	clone() Makes a shallow copy of the named list.
boolean	equals(Object obj)
Object	findRecursive(String... args) Recursively parses the NamedList structure to arrive at a specific element.
void	forEach(BiConsumer<String,? super T> action)
void	forEachEntry(BiConsumer<String,? super T> fun) Navigate through all keys and values
void	forEachKey(Consumer<String> fun) iterate through all keys The default impl is suboptimal.
T	get(String name) Gets the value for the first instance of the specified name found.
T	get(String name, int start) Gets the value for the first instance of the specified name found starting at the specified index.
List<T>	getAll(String name) Gets the values for the the specified name
Boolean	getBooleanArg(String name) Used for getting a boolean argument from a NamedList object.
NamedList<T>	getImmutableCopy()
String	getName(int idx) The name of the pair at the specified List index
T	getVal(int idx) The value of the pair at the specified List index
int	hashCode()
int	indexOf(String name, int start) Scans the list sequentially beginning at the specified index and returns the index of the first pair with the specified name.
Iterator<Map.Entry<String,T>>	iterator() Support the Iterable interface
T	remove(int idx) Removes the name/value pair at the specified index.
T	remove(String name) NOTE: this runs in linear time (it scans starting at the beginning of the list until it finds the first pair with the specified name).
List<T>	removeAll(String name) Removes and returns all values for the specified name.
Boolean	removeBooleanArg(String name) Used for getting a boolean argument from a NamedList object.
Collection<String>	removeConfigArgs(String name) Used for getting one or many arguments from NamedList objects that hold configuration parameters.
void	setName(int idx, String name) Modifies the name of the pair at the specified index.
T	setVal(int idx, T val) Modifies the value of the pair at the specified index.
int	size() The total number of name/value pairs
SolrParams	toSolrParams() Create SolrParams from NamedList.
String	toString()
void	writeMap(MapWriter.EntryWriter ew)

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

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

从接口继承的方法 java.lang.Iterable

forEach, spliterator

从接口继承的方法 org.apache.solr.cluster.api.SimpleMap

asMap, asMap, get

从接口继承的方法 org.apache.solr.common.MapWriter

jsonStr, toMap

从接口继承的方法 org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr

字段详细资料

nvPairs

protected final List<Object> nvPairs

构造器详细资料

NamedList

public NamedList()

Creates an empty instance

NamedList

public NamedList(int sz)

NamedList

public NamedList(Map.Entry<String,? extends T>[] nameValuePairs)

Creates a NamedList instance containing the "name,value" pairs contained in the Entry[].

Modifying the contents of the Entry[] after calling this constructor may change the NamedList (in future versions of Solr), but this is not guaranteed and should not be relied upon. To modify the NamedList, refer to add(String, Object) or remove(String).

参数:

nameValuePairs - the name value pairs

NamedList

public NamedList(Map<String,? extends T> nameValueMap)

Creates a NamedList instance containing the "name,value" pairs contained in the Map.

Modifying the contents of the Map after calling this constructor may change the NamedList (in future versions of Solr), but this is not guaranteed and should not be relied upon. To modify the NamedList, refer to add(String, Object) or remove(String).

参数:

nameValueMap - the name value pairs

方法详细资料

writeMap

public void writeMap(MapWriter.EntryWriter ew)
              throws IOException

指定者:

writeMap 在接口中 SimpleMap<T>

指定者:

writeMap 在接口中 MapWriter

抛出:

IOException

size

public int size()

The total number of name/value pairs

指定者:

size 在接口中 SimpleMap<T>

getName

public String getName(int idx)

The name of the pair at the specified List index

返回:

null if no name exists

getVal

public T getVal(int idx)

The value of the pair at the specified List index

返回:

may be null

add

public void add(String name,
                T val)

Adds a name/value pair to the end of the list.

setName

public void setName(int idx,
                    String name)

Modifies the name of the pair at the specified index.

setVal

public T setVal(int idx,
                T val)

Modifies the value of the pair at the specified index.

返回:

the value that used to be at index

remove

public T remove(int idx)

Removes the name/value pair at the specified index.

返回:

the value at the index removed

indexOf

public int indexOf(String name,
                   int start)

Scans the list sequentially beginning at the specified index and returns the index of the first pair with the specified name.

参数:

name - name to look for, may be null

start - index to begin searching from

返回:

The index of the first matching pair, -1 if no match

get

public T get(String name)

Gets the value for the first instance of the specified name found.

NOTE: this runs in linear time (it scans starting at the beginning of the list until it finds the first pair with the specified name).

指定者:

get 在接口中 SimpleMap<T>

返回:

null if not found or if the value stored was null.

另请参阅:

indexOf(java.lang.String, int), get(String,int)

get

public T get(String name,
             int start)

Gets the value for the first instance of the specified name found starting at the specified index.

NOTE: this runs in linear time (it scans starting at the specified position until it finds the first pair with the specified name).

返回:

null if not found or if the value stored was null.

另请参阅:

indexOf(java.lang.String, int)

getAll

public List<T> getAll(String name)

Gets the values for the the specified name

参数:

name - Name

返回:

List of values

findRecursive

public Object findRecursive(String... args)

Recursively parses the NamedList structure to arrive at a specific element. As you descend the NamedList tree, the last element can be any type, including NamedList, but the previous elements MUST be NamedList objects themselves. A null value is returned if the indicated hierarchy doesn't exist, but NamedList allows null values so that could be the actual value at the end of the path. This method is particularly useful for parsing the response from Solr's /admin/mbeans handler, but it also works for any complex structure. Explicitly casting the return value is recommended. An even safer option is to accept the return value as an object and then check its type. Usage examples: String coreName = (String) response.findRecursive ("solr-mbeans", "CORE", "core", "stats", "coreName"); long numDoc = (long) response.findRecursive ("solr-mbeans", "CORE", "searcher", "stats", "numDocs");

参数:

args - One or more strings specifying the tree to navigate.

返回:

the last entry in the given path hierarchy, null if not found.

toString

public String toString()

覆盖:

toString 在类中 Object

getImmutableCopy

public NamedList<T> getImmutableCopy()

asShallowMap

public Map<String,T> asShallowMap()

asShallowMap

public Map<String,T> asShallowMap(boolean allowDps)

asMap

public Map asMap(int maxDepth)

toSolrParams

public SolrParams toSolrParams()

Create SolrParams from NamedList. Values must be String[] or List (with toString()-appropriate entries), or otherwise have a toString()-appropriate value. Nulls are retained as such in arrays/lists but otherwise will NPE.

addAll

public boolean addAll(Map<String,T> args)

Iterates over the Map and sequentially adds its key/value pairs

addAll

public boolean addAll(NamedList<T> nl)

Appends the elements of the given NamedList to this one.

clone

public NamedList<T> clone()

Makes a shallow copy of the named list.

覆盖:

clone 在类中 Object

iterator

public Iterator<Map.Entry<String,T>> iterator()

Support the Iterable interface

指定者:

iterator 在接口中 Iterable<Map.Entry<String,T>>

remove

public T remove(String name)

NOTE: this runs in linear time (it scans starting at the beginning of the list until it finds the first pair with the specified name).

removeAll

public List<T> removeAll(String name)

Removes and returns all values for the specified name. Returns null if no matches found. This method will return all matching objects, regardless of data type. If you are parsing Solr config options, the removeConfigArgs(String) or removeBooleanArg(String) methods will probably work better.

参数:

name - Name

返回:

List of values

removeBooleanArg

public Boolean removeBooleanArg(String name)

Used for getting a boolean argument from a NamedList object. If the name is not present, returns null. If there is more than one value with that name, or if the value found is not a Boolean or a String, throws an exception. If there is only one value present and it is a Boolean or a String, the value is removed and returned as a Boolean. If an exception is thrown, the NamedList is not modified. See removeAll(String) and removeConfigArgs(String) for additional ways of gathering configuration information from a NamedList.

参数:

name - The key to look up in the NamedList.

返回:

The boolean value found.

抛出:

SolrException - If multiple values are found for the name or the value found is not a Boolean or a String.

getBooleanArg

public Boolean getBooleanArg(String name)

Used for getting a boolean argument from a NamedList object. If the name is not present, returns null. If there is more than one value with that name, or if the value found is not a Boolean or a String, throws an exception. If there is only one value present and it is a Boolean or a String, the value is returned as a Boolean. The NamedList is not modified. See remove(String), removeAll(String) and removeConfigArgs(String) for additional ways of gathering configuration information from a NamedList.

参数:

name - The key to look up in the NamedList.

返回:

The boolean value found.

抛出:

SolrException - If multiple values are found for the name or the value found is not a Boolean or a String.

removeConfigArgs

public Collection<String> removeConfigArgs(String name)
                                    throws SolrException

Used for getting one or many arguments from NamedList objects that hold configuration parameters. Finds all entries in the NamedList that match the given name. If they are all strings or arrays of strings, remove them from the NamedList and return the individual elements as a Collection. Parameter order will be preserved if the returned collection is handled as an ArrayList. Throws SolrException if any of the values associated with the name are not strings or arrays of strings. If exception is thrown, the NamedList is not modified. Returns an empty collection if no matches found. If you need to remove and retrieve all matching items from the NamedList regardless of data type, use removeAll(String) instead. The removeBooleanArg(String) method can be used for retrieving a boolean argument.

参数:

name - The key to look up in the NamedList.

返回:

A collection of the values found.

抛出:

SolrException - If values are found for the input key that are not strings or arrays of strings.

clear

public void clear()

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

abortableForEach

public void abortableForEach(BiFunction<String,? super T,Boolean> fun)

从接口复制的说明: SimpleMap

Navigate through all key-values but abort in between if required. The default impl is suboptimal. Proper implementations must do it more efficiently

指定者:

abortableForEach 在接口中 SimpleMap<T>

参数:

fun - Consume each entry and return a boolean to signal whether to proceed or not. If true, continue, if false stop

abortableForEachKey

public void abortableForEachKey(Function<String,Boolean> fun)

从接口复制的说明: SimpleMap

iterate through all keys but abort in between if required The default impl is suboptimal. Proper implementations must do it more efficiently

指定者:

abortableForEachKey 在接口中 SimpleMap<T>

参数:

fun - Consume each key and return a boolean to signal whether to proceed or not. If true , continue. If false stop

forEachKey

public void forEachKey(Consumer<String> fun)

从接口复制的说明: SimpleMap

iterate through all keys The default impl is suboptimal. Proper implementations must do it more efficiently

指定者:

forEachKey 在接口中 SimpleMap<T>

forEach

public void forEach(BiConsumer<String,? super T> action)

_size

public int _size()

指定者:

_size 在接口中 NavigableObject

forEachEntry

public void forEachEntry(BiConsumer<String,? super T> fun)

从接口复制的说明: SimpleMap

Navigate through all keys and values

指定者:

forEachEntry 在接口中 SimpleMap<T>