Open Source Repository

Home /spring/spring-context-3.0.5 | Repository Home


org/springframework/stereotype/Repository.java
/*
 * Copyright 2002-2007 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
 *
 *      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 org.springframework.stereotype;

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

/**
 * Indicates that an annotated class is a "Repository" (or "DAO").
 
 <p>A class thus annotated is eligible for Spring
 {@link org.springframework.dao.DataAccessException} translation. The
 * annotated class is also clarified as to its role in the overall
 * application architecture for the purpose of tools, aspects, etc.
 *
 <p>As of Spring 2.5, this annotation also serves as a specialization
 * of {@link Component @Component}, allowing for implementation classes
 * to be autodetected through classpath scanning.
 *
 @author Rod Johnson
 @author Juergen Hoeller
 @since 2.0
 @see Component
 @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {

  /**
   * The value may indicate a suggestion for a logical component name,
   * to be turned into a Spring bean in case of an autodetected component.
   @return the suggested component name, if any
   */
  String value() default "";

}