org.identityconnectors.framework.common.objects.filter.EqualsFilter Maven / Gradle / Ivy
/*
* ====================
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
* except in compliance with the License.
*
* You can obtain a copy of the License at
* http://IdentityConnectors.dev.java.net/legal/license.txt
* See the License for the specific language governing permissions and limitations
* under the License.
*
* When distributing the Covered Code, include this CDDL Header Notice in each file
* and include the License file at identityconnectors/legal/license.txt.
* If applicable, add the following below this CDDL Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
*/
package org.identityconnectors.framework.common.objects.filter;
import org.identityconnectors.framework.common.objects.Attribute;
import org.identityconnectors.framework.common.objects.ConnectorObject;
/**
* Determines whether an {@link ConnectorObject object}
* contains an {@link Attribute attribute} that matches
* a specific attribute value.
*/
public final class EqualsFilter extends AttributeFilter {
/**
* Public only as an artifact of the implementation.
* Please use {@link FilterBuilder#equalTo(Attribute) FilterBuilder}
* to create an instance of {@code EqualsFilter}.
*/
public EqualsFilter(Attribute attr) {
super(attr);
}
/**
* Determines whether the specified {@link ConnectorObject}
* contains an attribute that has the same name
* and contains a value that is equals the value of
* the attribute that {@code FilterBuilder}
* placed into this filter.
*
* Note that in the case of a multi-valued attribute,
* equality of values means that:
*
* - the value of the attribute in the connector object
* and the value of the attribute in the filter
* must contain the same number of elements; and that
*
* - each element within the value of the attribute in the connector object
* must equal the element that occupies the same position
* within the value of the attribute in the filter.
*
*
*
* @see Filter#accept(ConnectorObject)
*/
public boolean accept(ConnectorObject obj) {
boolean ret = false;
Attribute thisAttr = getAttribute();
Attribute attr = obj.getAttributeByName(thisAttr.getName());
if (attr != null) {
ret = thisAttr.equals(attr);
}
return ret;
}
@Override
public String toString() {
StringBuilder bld = new StringBuilder();
bld.append("EQUALS: ").append(getAttribute());
return bld.toString();
}
}