net.bytebuddy.matcher.ElementMatcher Maven / Gradle / Ivy
/*
* Copyright 2014 - Present Rafael Winterhalter
*
* 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 net.bytebuddy.matcher;
import net.bytebuddy.build.HashCodeAndEqualsPlugin;
import net.bytebuddy.utility.nullability.MaybeNull;
import net.bytebuddy.utility.nullability.UnknownNull;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* An element matcher is used as a predicate for identifying code elements such as types, methods, fields or
* annotations. They are similar to Java 8's {@code Predicate}s but compatible to Java 6 and Java 7 and represent
* a functional interface. They can be chained by using instances of
* {@link net.bytebuddy.matcher.ElementMatcher.Junction}.
*
* @param The type of the object that is being matched.
*/
public interface ElementMatcher {
/**
* Matches a target against this element matcher.
*
* @param target The instance to be matched or {@code null}.
* @return {@code true} if the given element is matched by this matcher or {@code false} otherwise.
*/
boolean matches(@UnknownNull T target);
/**
* A junctions allows to chain different {@link net.bytebuddy.matcher.ElementMatcher}s in a readable manner.
*
* @param The type of the object that is being matched.
*/
interface Junction extends ElementMatcher {
/**
* Creates a conjunction where this matcher and the {@code other} matcher must both be matched in order
* to constitute a successful match. The other matcher is only invoked if this matcher constitutes a successful
* match.
*
* @param other The second matcher to consult.
* @param The type of the object that is being matched. Note that Java's type inference might not
* be able to infer the common subtype of this instance and the {@code other} matcher such that
* this type must need to be named explicitly.
* @return A conjunction of this matcher and the other matcher.
*/
Junction and(ElementMatcher other);
/**
* Creates a disjunction where either this matcher or the {@code other} matcher must be matched in order
* to constitute a successful match. The other matcher is only invoked if this matcher constitutes an
* unsuccessful match.
*
* @param other The second matcher to consult.
* @param The type of the object that is being matched. Note that Java's type inference might not
* be able to infer the common subtype of this instance and the {@code other} matcher such that
* this type must need to be named explicitly.
* @return A disjunction of this matcher and the other matcher.
*/
Junction or(ElementMatcher other);
/**
* A base implementation of {@link net.bytebuddy.matcher.ElementMatcher.Junction}.
*
* @param The type of the object that is being matched.
*/
abstract class AbstractBase implements Junction {
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked") // In absence of @SafeVarargs
public Junction and(ElementMatcher other) {
return new Conjunction(this, other);
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked") // In absence of @SafeVarargs
public Junction or(ElementMatcher other) {
return new Disjunction(this, other);
}
}
/**
* A conjunction matcher which only matches an element if both represented matchers constitute a match.
*
* @param The type of the object that is being matched.
*/
@HashCodeAndEqualsPlugin.Enhance
class Conjunction extends AbstractBase {
/**
* The element matchers that constitute this conjunction.
*/
private final List> matchers;
/**
* Creates a new conjunction matcher.
*
* @param matcher The represented matchers in application order.
*/
@SuppressWarnings("unchecked") // In absence of @SafeVarargs
public Conjunction(ElementMatcher... matcher) {
this(Arrays.asList(matcher));
}
/**
* Creates a new conjunction matcher.
*
* @param matchers The represented matchers in application order.
*/
@SuppressWarnings("unchecked")
public Conjunction(List> matchers) {
this.matchers = new ArrayList>(matchers.size());
for (ElementMatcher matcher : matchers) {
if (matcher instanceof Conjunction) {
this.matchers.addAll(((Conjunction