org.springframework.ldap.filter.NotPresentFilter Maven / Gradle / Ivy
/*
* Copyright 2005-2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.ldap.filter;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.springframework.ldap.filter.AbstractFilter;
/**
* A convenience class that combines {@code NOT} behavior with {@code present}
* behavior to allow the user to check for the non-existence of a attribute. For
* an attribute to be {@code NOT present} it must not have any values set. To
* filter on attributes at are {@code present} use the {@link PresentFilter}.
*
*
* NotPresentFilter filter = new NotPresentFilter("foo");
* System.out.println(filter.encode());
*
*
* would result in:
*
*
* (!(foo=*))
*
* @author Jordan Hein
*/
public class NotPresentFilter extends AbstractFilter {
private String attribute;
/**
* Creates a new instance of a not present filter for a particular
* attribute.
*
* @param attribute the attribute expected to be not-present (ie, unset, or
* null).
*/
public NotPresentFilter(String attribute) {
this.attribute = attribute;
}
public StringBuffer encode(StringBuffer buff) {
buff.append("(!(");
buff.append(attribute);
buff.append("=*))");
return buff;
}
/*
* @see java.lang.Object#equals(java.lang.Object)
*/
public boolean equals(Object o) {
if (o == null) {
return false;
}
if (o == this) {
return true;
}
if (o.getClass() != getClass()) {
return false;
}
NotPresentFilter f = (NotPresentFilter) o;
return new EqualsBuilder().append(this.attribute, f.attribute).isEquals();
}
/*
* @see java.lang.Object#hashCode()
*/
public int hashCode() {
HashCodeBuilder builder = new HashCodeBuilder().append(attribute);
return builder.toHashCode();
}
}