org.jdom.filter

Class ElementFilter

Implemented Interfaces:
Filter

public class ElementFilter
extends java.lang.Object
implements Filter

The ElementFilter when applied to a FilterList will only allow Elements to be visible.
Version:
$Revision: 1.2 $, $Date: 2002/03/13 06:25:33 $
Authors:
Jools Enticknap
Bradley S. Huffman

Field Summary

protected String
name
The element name
protected Namespace
namespace
The element namespace

Constructor Summary

ElementFilter()
Filter out the Elements.
ElementFilter(String name)
Filter out the Elements with the supplied name in any Namespace.
ElementFilter(String name, Namespace namespace)
Filter out the Elements with the supplied name and Namespace.
ElementFilter(Namespace namespace)
Filter out the Elements with the supplied Namespace.

Method Summary

boolean
canAdd(Object obj)
Only allow the adding of Element objects.
boolean
canRemove(Object obj)
Check to see if the object can be removed from the list.
boolean
equals(Object obj)
Returns true if object is instance of ElementFilter and has the same parent Element, name, and namespace as this filter.
boolean
matches(Object obj)
Check to see if the object matches a predefined set of rules.

Field Details

name

protected String name
The element name

namespace

protected Namespace namespace
The element namespace

Constructor Details

ElementFilter

public ElementFilter()
Filter out the Elements.

ElementFilter

public ElementFilter(String name)
Filter out the Elements with the supplied name in any Namespace.
Parameters:
name - The name of the Element.

ElementFilter

public ElementFilter(String name,
                     Namespace namespace)
Filter out the Elements with the supplied name and Namespace.
Parameters:
name - The name of the Element.
namespace - The namespace the Element lives in.

ElementFilter

public ElementFilter(Namespace namespace)
Filter out the Elements with the supplied Namespace.
Parameters:
namespace - The namespace the Element lives in.

Method Details

canAdd

public boolean canAdd(Object obj)
Only allow the adding of Element objects.
Specified by:
canAdd in interface Filter
Parameters:
obj - The object to verify.
Returns:
true if the object can be added.

canRemove

public boolean canRemove(Object obj)
Check to see if the object can be removed from the list.
Specified by:
canRemove in interface Filter
Parameters:
obj - The object to verify.
Returns:
true if the object can be removed.

equals

public boolean equals(Object obj)
Returns true if object is instance of ElementFilter and has the same parent Element, name, and namespace as this filter.
Returns:
true if the Filters are equal

matches

public boolean matches(Object obj)
Check to see if the object matches a predefined set of rules.
Specified by:
matches in interface Filter
Parameters:
obj - The object to verify.
Returns:
true if the objected matched a predfined set of rules.

Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.