org.springframework.context.expression.AnnotatedElementKey Maven / Gradle / Ivy
/*
* Copyright 2002-2023 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
*
* https://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.context.expression;
import java.lang.reflect.AnnotatedElement;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
/**
* Represent an {@link AnnotatedElement} on a particular {@link Class}
* and is suitable as a key.
*
* @author Costin Leau
* @author Stephane Nicoll
* @since 4.2
* @see CachedExpressionEvaluator
*/
public final class AnnotatedElementKey implements Comparable {
private final AnnotatedElement element;
@Nullable
private final Class targetClass;
/**
* Create a new instance with the specified {@link AnnotatedElement} and
* optional target {@link Class}.
*/
public AnnotatedElementKey(AnnotatedElement element, @Nullable Class targetClass) {
Assert.notNull(element, "AnnotatedElement must not be null");
this.element = element;
this.targetClass = targetClass;
}
@Override
public boolean equals(@Nullable Object other) {
return (this == other || (other instanceof AnnotatedElementKey that &&
this.element.equals(that.element) &&
ObjectUtils.nullSafeEquals(this.targetClass, that.targetClass)));
}
@Override
public int hashCode() {
return this.element.hashCode() + (this.targetClass != null ? this.targetClass.hashCode() * 29 : 0);
}
@Override
public String toString() {
return this.element + (this.targetClass != null ? " on " + this.targetClass : "");
}
@Override
public int compareTo(AnnotatedElementKey other) {
int result = this.element.toString().compareTo(other.element.toString());
if (result == 0 && this.targetClass != null) {
if (other.targetClass == null) {
return 1;
}
result = this.targetClass.getName().compareTo(other.targetClass.getName());
}
return result;
}
}