com.querydsl.core.annotations.QueryDelegate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of querydsl-core Show documentation

core module for querydsl

The newest version!

/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * 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.querydsl.core.annotations;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Declaration of a static delegate method
 *
 * Example :
 *
 * 
 * {@code @QueryDelegate(User.class)}
 * public static Predicate like(QUser entity, User user) {
 *     BooleanBuilder builder = new BooleanBuilder();
 *     if (user.getFirstName() != null) {
 *         builder.and(entity.firstName.eq(user.getFirstName()));
 *     }
 *     if (user.getLastName() != null) {
 *         builder.and(entity.lastName.eq(user.getLastName()));
 *     }
 *     return builder.getValue();
 * }
 * 
 *
 * This will be then available in the QUser type as an instance method without the first
 * argument:
 *
 * 
 * User user = new User();
 * user.setFirstName("John");
 * user.setLastName("Doe");
 * Predicate predicate = QUser.user.like(user);
 * 
 *
 * @author tiwe
 */
@Documented
@Target({METHOD})
@Retention(RUNTIME)
public @interface QueryDelegate {

  /** Target type for delegate expansion */
  Class value();
}