org.jdom.filter
Class ContentFilter
- Filter, java.io.Serializable
public class ContentFilter
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.
$Revision: 1.15 $, $Date: 2007/11/10 05:29:00 $
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(Object obj) - Returns whether the two filters are equivalent (i.e. the
matching mask values are identical).
|
int | getFilterMask() - Return current filtering mask.
|
int | hashCode()
|
boolean | matches(Object obj) - Check to see if the object matches according to the filter mask.
|
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.
|
CDATA
public static final int CDATA
Mask for JDOM
CDATA
objects
COMMENT
public static final int COMMENT
DOCTYPE
public static final int DOCTYPE
DOCUMENT
public static final int DOCUMENT
ELEMENT
public static final int ELEMENT
ENTITYREF
public static final int ENTITYREF
PI
public static final int PI
TEXT
public static final int TEXT
Mask for JDOM
Text
objects
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.
equals
public boolean equals(Object obj)
Returns whether the two filters are equivalent (i.e. the
matching mask values are identical).
obj
- the object to compare against
- whether the two filters are equal
getFilterMask
public int getFilterMask()
Return current filtering mask.
- the current filtering mask
hashCode
public int hashCode()
matches
public boolean matches(Object obj)
Check to see if the object matches according to the filter mask.
- matches in interface Filter
obj
- The object to verify.
true
if the objected matched a predfined
set of rules.
setCDATAVisible
public void setCDATAVisible(boolean visible)
Set visiblity of CDATA
objects.
visible
- whether CDATA 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
setDefaultMask
public void setDefaultMask()
Set this filter to allow all legal JDOM objects.
setDocTypeVisible
public void setDocTypeVisible(boolean visible)
Set visiblity of DocType
objects.
visible
- whether the DocType is visible, true
if yes, false
if not
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
setEntityRefVisible
public void setEntityRefVisible(boolean visible)
Set visiblity of EntityRef
objects.
visible
- whether EntityRefs are visible, true
if yes, false
if not
setFilterMask
public void setFilterMask(int mask)
Set filtering mask.
mask
- the new filtering mask
setPIVisible
public void setPIVisible(boolean visible)
Set visiblity of ProcessingInstruction
objects.
visible
- whether ProcessingInstructions 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
Copyright B) 2007 Jason Hunter, Brett McLaughlin. All Rights Reserved.