src/com/google/inject/intercept/Queries.java

/**
 * Copyright (C) 2006 Google Inc.
 *
 * 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 com.google.inject.intercept;

import com.google.inject.util.Objects;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;

/**
 * Query implementations. Supports querying classes and methods.
 *
 * @author crazybob@google.com (Bob Lee)
 */
public class Queries {

  private Queries() {}

  static Query<Object> ANY = new AbstractQuery<Object>() {
    public boolean matches(Object o) {
      return true;
    }

    public String toString() {
      return "any()";
    }
  };

  /**
   * Returns a query which matches any input.
   */
  public static Query<Object> any() {
    return ANY;
  }

  /**
   * Inverts the given query.
   */
  public static <T> Query<T> not(final Query<? super T> p) {
    Objects.nonNull(p, "p");
    return new AbstractQuery<T>() {
      public boolean matches(T t) {
        return !p.matches(t);
      }

      public String toString() {
        return "not(" + p + ")";
      }
    };
  }

  /**
   * Returns a query which matches elements (methods, classes, etc.)
   * with a given annotation.
   */
  public static Query<AnnotatedElement> annotatedWith(
      final Class<? extends Annotation> annotationType) {
    Objects.nonNull(annotationType, "annotation type");
    return new AbstractQuery<AnnotatedElement>() {
      public boolean matches(AnnotatedElement element) {
        Annotation annotation = element.getAnnotation(annotationType);
        return annotation != null;
      }

      public String toString() {
        return "annotatedWith(" + annotationType.getSimpleName() + ".class)";
      }
    };
  }

  /**
   * Returns a query which matches subclasses of the given type (as well as
   * the given type).
   */
  public static Query<Class> subclassesOf(final Class<?> superclass) {
    Objects.nonNull(superclass, "superclass");
    return new AbstractQuery<Class>() {
      public boolean matches(Class subclass) {
        return superclass.isAssignableFrom(subclass);
      }

      public String toString() {
        return "subclassesOf(" + superclass.getSimpleName() + ".class)";
      }
    };
  }

  /**
   * Returns a query which matches objects equal to the given object.
   */
  public static Query<Object> only(final Object o) {
    Objects.nonNull(o, "o");
    return new AbstractQuery<Object>() {
      public boolean matches(Object other) {
        return o.equals(other);
      }

      public String toString() {
        return "only(" + o + ")";
      }
    };
  }

  /**
   * Returns a query which matches only the given object.
   */
  public static Query<Object> identicalTo(final Object o) {
    Objects.nonNull(o, "o");
    return new AbstractQuery<Object>() {
      public boolean matches(Object other) {
        return o == other;
      }

      public String toString() {
        return "identicalTo(" + o + ")";
      }
    };
  }

  /**
   * Returns a query which matches classes in the given package.
   */
  public static Query<Class> inPackage(final Package p) {
    Objects.nonNull(p, "package");
    return new AbstractQuery<Class>() {
      public boolean matches(Class c) {
        return c.getPackage().equals(p);
      }

      public String toString() {
        return "package(" + p.getName() + ")";
      }
    };
  }

  /**
   * Returns a query which matches methods with matching return types.
   */
  public static Query<Method> returns(
      final Query<? super Class<?>> returnType) {
    Objects.nonNull(returnType, "return type query");
    return new AbstractQuery<Method>() {
      public boolean matches(Method m) {
        return returnType.matches(m.getReturnType());
      }

      public String toString() {
        return "returns(" + returnType + ")";
      }
    };
  }
}