Top Description Fields Constructors Methods
org.jdom2.filter

pack-priv final Class OrFilter

extends AbstractFilter<Content>
Class Inheritance
Imports
org.jdom2.Content
Allow two filters to be chained together with a logical or operation.
Author
Bradley S. Huffman

Field Summary

Modifier and TypeField and Description
private final Filter<?>
left

Filter for left side of logical or

private final Filter<?>
right

Filter for right side of logical or

private static final long
serialVersionUID

Hides org.jdom2.filter.AbstractFilter.serialVersionUID.

JDOM2 Serialization: Default mechanism

Constructor Summary

AccessConstructor and Description
public
OrFilter(Filter<?>
left side of logical or
left, Filter<?>
right side of logical or
right)

Match if either of the supplied filters.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Content
filter(Object
The content to test.
obj)

Implements org.jdom2.filter.Filter.filter.

Check to see if the content matches this Filter.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.jdom2.filter.AbstractFilter:
andfiltermatchesnegateorrefine

Field Detail

leftback to summary
private final Filter<?> left

Filter for left side of logical or

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jdom2.filter.AbstractFilter.serialVersionUID.

JDOM2 Serialization: Default mechanism

Constructor Detail

OrFilterback to summary
public OrFilter(Filter<?> left, Filter<?> right)

Match if either of the supplied filters.

Parameters
left:Filter<?>

left side of logical or

right:Filter<?>

right side of logical or

Exceptions
IllegalArgumentException:
if either supplied filter is null

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
filterback to summary
public Content filter(Object obj)

Implements org.jdom2.filter.Filter.filter.

Doc from org.jdom2.filter.Filter.filter.

Check to see if the content matches this Filter. If it does, return the content cast as this filter's return type, otherwise return null.

Parameters
obj:Object

The content to test.

Returns:Content

The content if it matches the filter, cast as this Filter's type.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override