NodeList (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.anakia.NodeList

所有已实现的接口:

java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List
```
public class NodeList
extends java.lang.Object
implements java.util.List, java.lang.Cloneable
```
Provides a class for wrapping a list of JDOM objects primarily for use in template engines and other kinds of text transformation tools. It has a toString() method that will output the XML serialized form of the nodes it contains - again focusing on template engine usage, as well as the selectNodes(String) method that helps selecting a different set of nodes starting from the nodes in this list. The class also implements the List interface by simply delegating calls to the contained list (the subList(int, int) method is implemented by delegating to the contained list and wrapping the returned sublist into a NodeList).

构造器概要

构造器
构造器和说明
`NodeList()` Creates an empty node list.
`NodeList(org.jdom.Document document)` Creates a node list that holds a single `Document` node.
`NodeList(org.jdom.Element element)` Creates a node list that holds a single `Element` node.
`NodeList(java.util.List nodes)` Creates a node list that holds a list of nodes.
`NodeList(java.util.List nodes, boolean copy)` Creates a node list that holds a list of nodes.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(int index, java.lang.Object o)`
`boolean`	`add(java.lang.Object o)`
`boolean`	`addAll(java.util.Collection c)`
`boolean`	`addAll(int index, java.util.Collection c)`
`void`	`clear()`
`java.lang.Object`	`clone()` Returns a NodeList that contains the same nodes as this node list.
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection c)`
`boolean`	`equals(java.lang.Object o)` Tests for equality with another object.
`java.lang.Object`	`get(int index)`
`java.util.List`	`getList()` Retrieves the underlying list used to store the nodes.
`int`	`hashCode()` Returns the hash code of the contained list.
`int`	`indexOf(java.lang.Object o)`
`boolean`	`isEmpty()`
`java.util.Iterator`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator`	`listIterator()`
`java.util.ListIterator`	`listIterator(int index)`
`java.lang.Object`	`remove(int index)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection c)`
`boolean`	`retainAll(java.util.Collection c)`
`NodeList`	`selectNodes(java.lang.String xpathString)` Applies an XPath expression to the node list and returns the resulting node list.
`java.lang.Object`	`set(int index, java.lang.Object o)`
`int`	`size()`
`java.util.List`	`subList(int fromIndex, int toIndex)`
`java.lang.Object[]`	`toArray()`
`java.lang.Object[]`	`toArray(java.lang.Object[] a)`
`java.lang.String`	`toString()` This method returns the string resulting from concatenation of string representations of its nodes.

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.util.List
replaceAll, sort, spliterator

从接口继承的方法 java.util.Collection
parallelStream, removeIf, stream

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

- 构造器详细资料
  - NodeList
```
public NodeList()
```
    Creates an empty node list.
  - NodeList
```
public NodeList(org.jdom.Document document)
```
    Creates a node list that holds a single Document node.
    
    参数:
    
    document -
  - NodeList
```
public NodeList(org.jdom.Element element)
```
    Creates a node list that holds a single Element node.
    
    参数:
    
    element -
  - NodeList
```
public NodeList(java.util.List nodes)
```
    Creates a node list that holds a list of nodes.
    
    参数:
    
    nodes - the list of nodes this template should hold. The created template will copy the passed nodes list, so changes to the passed list will not affect the model.
  - NodeList
```
public NodeList(java.util.List nodes,
                boolean copy)
```
    Creates a node list that holds a list of nodes.
    
    参数:
    
    nodes - the list of nodes this template should hold.
    
    copy - if true, the created template will copy the passed nodes list, so changes to the passed list will not affect the model. If false, the model will reference the passed list and will sense changes in it, altough no operations on the list will be synchronized.
- 方法详细资料
  - getList
```
public java.util.List getList()
```
    Retrieves the underlying list used to store the nodes. Note however, that you can fully use the underlying list through the List interface of this class itself. You would probably access the underlying list only for synchronization purposes.
    
    返回:
    
    The internal node List.
  - toString
```
public java.lang.String toString()
```
    This method returns the string resulting from concatenation of string representations of its nodes. Each node is rendered using its XML serialization format. This greatly simplifies creating XML-transformation templates, as to output a node contained in variable x as XML fragment, you simply write ${x} in the template (or whatever your template engine uses as its expression syntax).
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    The Nodelist as printable object.
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Returns a NodeList that contains the same nodes as this node list.
    
    覆盖:
    
    clone 在类中 java.lang.Object
    
    返回:
    
    A clone of this list.
    
    抛出:
    
    java.lang.CloneNotSupportedException - if the contained list's class does not have an accessible no-arg constructor.
  - hashCode
```
public int hashCode()
```
    Returns the hash code of the contained list.
    
    指定者:
    
    hashCode 在接口中 java.util.Collection
    
    指定者:
    
    hashCode 在接口中 java.util.List
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    The hashcode of the list.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Tests for equality with another object.
    
    指定者:
    
    equals 在接口中 java.util.Collection
    
    指定者:
    
    equals 在接口中 java.util.List
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    o - the object to test for equality
    
    返回:
    
    true if the other object is also a NodeList and their contained List objects evaluate as equals.
  - selectNodes
```
public NodeList selectNodes(java.lang.String xpathString)
```
    Applies an XPath expression to the node list and returns the resulting node list. In order for this method to work, your application must have access to werken.xpath library classes. The implementation does cache the parsed format of XPath expressions in a weak hash map, keyed by the string representation of the XPath expression. As the string object passed as the argument is usually kept in the parsed template, this ensures that each XPath expression is parsed only once during the lifetime of the template that first invoked it.
    
    参数:
    
    xpathString - the XPath expression you wish to apply
    
    返回:
    
    a NodeList representing the nodes that are the result of application of the XPath to the current node list. It can be empty.
  - add
```
public boolean add(java.lang.Object o)
```
    指定者:
    
    add 在接口中 java.util.Collection
    
    指定者:
    
    add 在接口中 java.util.List
    
    另请参阅:
    
    List.add(java.lang.Object)
  - add
```
public void add(int index,
                java.lang.Object o)
```
    指定者:
    
    add 在接口中 java.util.List
    
    另请参阅:
    
    List.add(int, java.lang.Object)
  - addAll
```
public boolean addAll(java.util.Collection c)
```
    指定者:
    
    addAll 在接口中 java.util.Collection
    
    指定者:
    
    addAll 在接口中 java.util.List
    
    另请参阅:
    
    List.addAll(java.util.Collection)
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection c)
```
    指定者:
    
    addAll 在接口中 java.util.List
    
    另请参阅:
    
    List.addAll(int, java.util.Collection)
  - clear
```
public void clear()
```
    指定者:
    
    clear 在接口中 java.util.Collection
    
    指定者:
    
    clear 在接口中 java.util.List
    
    另请参阅:
    
    List.clear()
  - contains
```
public boolean contains(java.lang.Object o)
```
    指定者:
    
    contains 在接口中 java.util.Collection
    
    指定者:
    
    contains 在接口中 java.util.List
    
    另请参阅:
    
    List.contains(java.lang.Object)
  - containsAll
```
public boolean containsAll(java.util.Collection c)
```
    指定者:
    
    containsAll 在接口中 java.util.Collection
    
    指定者:
    
    containsAll 在接口中 java.util.List
    
    另请参阅:
    
    List.containsAll(java.util.Collection)
  - get
```
public java.lang.Object get(int index)
```
    指定者:
    
    get 在接口中 java.util.List
    
    另请参阅:
    
    List.get(int)
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    指定者:
    
    indexOf 在接口中 java.util.List
    
    另请参阅:
    
    List.indexOf(java.lang.Object)
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 java.util.Collection
    
    指定者:
    
    isEmpty 在接口中 java.util.List
    
    另请参阅:
    
    List.isEmpty()
  - iterator
```
public java.util.Iterator iterator()
```
    指定者:
    
    iterator 在接口中 java.lang.Iterable
    
    指定者:
    
    iterator 在接口中 java.util.Collection
    
    指定者:
    
    iterator 在接口中 java.util.List
    
    另请参阅:
    
    List.iterator()
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    指定者:
    
    lastIndexOf 在接口中 java.util.List
    
    另请参阅:
    
    List.lastIndexOf(java.lang.Object)
  - listIterator
```
public java.util.ListIterator listIterator()
```
    指定者:
    
    listIterator 在接口中 java.util.List
    
    另请参阅:
    
    List.listIterator()
  - listIterator
```
public java.util.ListIterator listIterator(int index)
```
    指定者:
    
    listIterator 在接口中 java.util.List
    
    另请参阅:
    
    List.listIterator(int)
  - remove
```
public java.lang.Object remove(int index)
```
    指定者:
    
    remove 在接口中 java.util.List
    
    另请参阅:
    
    List.remove(int)
  - remove
```
public boolean remove(java.lang.Object o)
```
    指定者:
    
    remove 在接口中 java.util.Collection
    
    指定者:
    
    remove 在接口中 java.util.List
    
    另请参阅:
    
    List.remove(java.lang.Object)
  - removeAll
```
public boolean removeAll(java.util.Collection c)
```
    指定者:
    
    removeAll 在接口中 java.util.Collection
    
    指定者:
    
    removeAll 在接口中 java.util.List
    
    另请参阅:
    
    List.removeAll(java.util.Collection)
  - retainAll
```
public boolean retainAll(java.util.Collection c)
```
    指定者:
    
    retainAll 在接口中 java.util.Collection
    
    指定者:
    
    retainAll 在接口中 java.util.List
    
    另请参阅:
    
    List.retainAll(java.util.Collection)
  - set
```
public java.lang.Object set(int index,
                            java.lang.Object o)
```
    指定者:
    
    set 在接口中 java.util.List
    
    另请参阅:
    
    List.set(int, java.lang.Object)
  - size
```
public int size()
```
    指定者:
    
    size 在接口中 java.util.Collection
    
    指定者:
    
    size 在接口中 java.util.List
    
    另请参阅:
    
    List.size()
  - subList
```
public java.util.List subList(int fromIndex,
                              int toIndex)
```
    指定者:
    
    subList 在接口中 java.util.List
    
    另请参阅:
    
    List.subList(int, int)
  - toArray
```
public java.lang.Object[] toArray()
```
    指定者:
    
    toArray 在接口中 java.util.Collection
    
    指定者:
    
    toArray 在接口中 java.util.List
    
    另请参阅:
    
    List.toArray()
  - toArray
```
public java.lang.Object[] toArray(java.lang.Object[] a)
```
    指定者:
    
    toArray 在接口中 java.util.Collection
    
    指定者:
    
    toArray 在接口中 java.util.List
    
    另请参阅:
    
    List.toArray(java.lang.Object[])

类 NodeList

构造器概要

方法概要

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

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

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

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

构造器详细资料

NodeList

NodeList

NodeList

NodeList

NodeList

方法详细资料

getList

toString

clone

hashCode

equals

selectNodes

add

add

addAll

addAll

clear

contains

containsAll

get

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

size

subList

toArray

toArray