com.datastax.oss.driver.api.mapper.annotations.Dao Maven / Gradle / Ivy
/*
* Copyright DataStax, 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.datastax.oss.driver.api.mapper.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotates an interface that defines a set of query methods, usually (but not necessarily) related
* to a given entity class.
*
* Example:
*
*
* @Dao
* public interface ProductDao {
* @Select
* Product findById(UUID productId);
*
* @Insert
* void save(Product product);
*
* @Delete
* void delete(Product product);
* }
*
*
* DAO instances are created via {@link DaoFactory} methods.
*
* DAO interfaces can define the following methods:
*
*
* - {@link Delete}
*
- {@link GetEntity}
*
- {@link Insert}
*
- {@link Query}
*
- {@link QueryProvider}
*
- {@link Select}
*
- {@link SetEntity}
*
- {@link Update}
*
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Dao {}