1 /** 2 * Copyright (C) 2010 Google, Inc. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.inject.persist.finder; 18 19 import java.lang.annotation.ElementType; 20 import java.lang.annotation.Retention; 21 import java.lang.annotation.RetentionPolicy; 22 import java.lang.annotation.Target; 23 import java.util.Collection; 24 25 /** 26 * Marks a method stub as a dynamic finder. The method is intercepted and replaced with the 27 * specified JPAQL query. Provides result auto-boxing and automatic parameter binding. 28 * 29 * @author Dhanji R. Prasanna (dhanji@gmail.com) 30 */ 31 @Target(ElementType.METHOD) 32 @Retention(RetentionPolicy.RUNTIME) 33 public @interface Finder { 34 /** 35 * Returns the configured named query's name. Specify a named query's name 36 * here. This name is typically specified in your JPA configuration. 37 */ namedQuery()38 String namedQuery() default ""; 39 40 /** 41 * Returns the configured query string. Directly specify a JPAQL query here. 42 */ query()43 String query() default ""; 44 45 /** 46 * Returns the configured autoboxing collection class. 47 * Use this clause to specify a collection impl to autobox result lists into. The impl must 48 * have a default no-arg constructor and be a subclass of {@code java.util.Collection}. 49 */ returnAs()50 Class<? extends Collection> returnAs() default Collection.class; 51 }