ContentFilter

java.lang.Object
- org.jdom2.filter.AbstractFilter<Content>
- - org.jdom2.filter.ContentFilter

所有已实现的接口:

java.io.Serializable, Filter<Content>
```
public class ContentFilter
extends AbstractFilter<Content>
```
A general purpose Filter able to represent all legal JDOM objects or a specific subset. Filtering is accomplished by way of a filtering mask in which each bit represents whether a JDOM object is visible or not. For example to view all Text and CDATA nodes in the content of element x.
```
      Filter filter = new ContentFilter(ContentFilter.TEXT |
                                        ContentFilter.CDATA);
      List content = x.getContent(filter);
 
```
For those who don't like bit-masking, set methods are provided as an alternative. For example to allow everything except Comment nodes.
```
      Filter filter =  new ContentFilter();
      filter.setCommentVisible(false);
      List content = x.getContent(filter);
 
```
The default is to allow all valid JDOM objects.
作者:

Bradley S. Huffman

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`static int`	`CDATA` Mask for JDOM `CDATA` objects
`static int`	`COMMENT` Mask for JDOM `Comment` objects
`static int`	`DOCTYPE` Mask for JDOM `DocType` object
`static int`	`DOCUMENT` Mask for JDOM `Document` object
`static int`	`ELEMENT` Mask for JDOM `Element` objects
`static int`	`ENTITYREF` Mask for JDOM `EntityRef` objects
`static int`	`PI` Mask for JDOM `ProcessingInstruction` objects
`static int`	`TEXT` Mask for JDOM `Text` objects

构造器概要

构造器
构造器和说明
`ContentFilter()` Default constructor that allows any legal JDOM objects.
`ContentFilter(boolean allVisible)` Set whether all JDOM objects are visible or not.
`ContentFilter(int mask)` Filter out JDOM objects according to a filtering mask.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object obj)` Returns whether the two filters are equivalent (i.e. the matching mask values are identical).
`Content`	`filter(java.lang.Object obj)` Check to see if the object matches according to the filter mask.
`int`	`getFilterMask()` Return current filtering mask.
`int`	`hashCode()`
`void`	`setCDATAVisible(boolean visible)` Set visiblity of `CDATA` objects.
`void`	`setCommentVisible(boolean visible)` Set visiblity of `Comment` objects.
`void`	`setDefaultMask()` Set this filter to allow all legal JDOM objects.
`void`	`setDocTypeVisible(boolean visible)` Set visiblity of `DocType` objects.
`void`	`setDocumentContent()` Set filter to match only JDOM objects that are legal document content.
`void`	`setElementContent()` Set filter to match only JDOM objects that are legal element content.
`void`	`setElementVisible(boolean visible)` Set visiblity of `Element` objects.
`void`	`setEntityRefVisible(boolean visible)` Set visiblity of `EntityRef` objects.
`void`	`setFilterMask(int mask)` Set filtering mask.
`void`	`setPIVisible(boolean visible)` Set visiblity of `ProcessingInstruction` objects.
`void`	`setTextVisible(boolean visible)` Set visiblity of `Text` objects.

从类继承的方法 org.jdom2.filter.AbstractFilter
and, filter, matches, negate, or, refine

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

- 字段详细资料
  - ELEMENT
```
public static final int ELEMENT
```
    Mask for JDOM Element objects
    
    另请参阅:
    
    常量字段值
  - CDATA
```
public static final int CDATA
```
    Mask for JDOM CDATA objects
    
    另请参阅:
    
    常量字段值
  - TEXT
```
public static final int TEXT
```
    Mask for JDOM Text objects
    
    另请参阅:
    
    常量字段值
  - COMMENT
```
public static final int COMMENT
```
    Mask for JDOM Comment objects
    
    另请参阅:
    
    常量字段值
  - PI
```
public static final int PI
```
    Mask for JDOM ProcessingInstruction objects
    
    另请参阅:
    
    常量字段值
  - ENTITYREF
```
public static final int ENTITYREF
```
    Mask for JDOM EntityRef objects
    
    另请参阅:
    
    常量字段值
  - DOCUMENT
```
public static final int DOCUMENT
```
    Mask for JDOM Document object
    
    另请参阅:
    
    常量字段值
  - DOCTYPE
```
public static final int DOCTYPE
```
    Mask for JDOM DocType object
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ContentFilter
```
public ContentFilter()
```
    Default constructor that allows any legal JDOM objects.
  - ContentFilter
```
public ContentFilter(boolean allVisible)
```
    Set whether all JDOM objects are visible or not.
    
    参数:
    
    allVisible - true all JDOM objects are visible, false all JDOM objects are hidden.
  - ContentFilter
```
public ContentFilter(int mask)
```
    Filter out JDOM objects according to a filtering mask.
    
    参数:
    
    mask - Mask of JDOM objects to allow.
- 方法详细资料
  - getFilterMask
```
public int getFilterMask()
```
    Return current filtering mask.
    
    返回:
    
    the current filtering mask
  - setFilterMask
```
public void setFilterMask(int mask)
```
    Set filtering mask.
    
    参数:
    
    mask - the new filtering mask
  - setDefaultMask
```
public void setDefaultMask()
```
    Set this filter to allow all legal JDOM objects.
  - setDocumentContent
```
public void setDocumentContent()
```
    Set filter to match only JDOM objects that are legal document content.
  - setElementContent
```
public void setElementContent()
```
    Set filter to match only JDOM objects that are legal element content.
  - setElementVisible
```
public void setElementVisible(boolean visible)
```
    Set visiblity of Element objects.
    
    参数:
    
    visible - whether Elements are visible, true if yes, false if not
  - setCDATAVisible
```
public void setCDATAVisible(boolean visible)
```
    Set visiblity of CDATA objects.
    
    参数:
    
    visible - whether CDATA nodes are visible, true if yes, false if not
  - setTextVisible
```
public void setTextVisible(boolean visible)
```
    Set visiblity of Text objects.
    
    参数:
    
    visible - whether Text nodes are visible, true if yes, false if not
  - setCommentVisible
```
public void setCommentVisible(boolean visible)
```
    Set visiblity of Comment objects.
    
    参数:
    
    visible - whether Comments are visible, true if yes, false if not
  - setPIVisible
```
public void setPIVisible(boolean visible)
```
    Set visiblity of ProcessingInstruction objects.
    
    参数:
    
    visible - whether ProcessingInstructions are visible, true if yes, false if not
  - setEntityRefVisible
```
public void setEntityRefVisible(boolean visible)
```
    Set visiblity of EntityRef objects.
    
    参数:
    
    visible - whether EntityRefs are visible, true if yes, false if not
  - setDocTypeVisible
```
public void setDocTypeVisible(boolean visible)
```
    Set visiblity of DocType objects.
    
    参数:
    
    visible - whether the DocType is visible, true if yes, false if not
  - filter
```
public Content filter(java.lang.Object obj)
```
    Check to see if the object matches according to the filter mask.
    
    参数:
    
    obj - The object to verify.
    
    返回:
    
    true if the objected matched a predfined set of rules.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns whether the two filters are equivalent (i.e. the matching mask values are identical).
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    obj - the object to compare against
    
    返回:
    
    whether the two filters are equal
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object

类 ContentFilter

字段概要

构造器概要

方法概要

从类继承的方法 org.jdom2.filter.AbstractFilter

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

字段详细资料

ELEMENT

CDATA

TEXT

COMMENT

PI

ENTITYREF

DOCUMENT

DOCTYPE

构造器详细资料

ContentFilter

ContentFilter

ContentFilter

方法详细资料

getFilterMask

setFilterMask

setDefaultMask

setDocumentContent

setElementContent

setElementVisible

setCDATAVisible

setTextVisible

setCommentVisible

setPIVisible

setEntityRefVisible

setDocTypeVisible

filter

equals

hashCode