1 /* 2 * Copyright (C) 2016 The Android Open Source Project 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 androidx.room; 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 24 /** 25 * Marks a method in a {@link Dao} annotated class as a delete method. 26 * <p> 27 * The implementation of the method will delete its parameters from the database. 28 * <p> 29 * All of the parameters of the Delete method must either be classes annotated with {@link Entity} 30 * or collections/array of it. 31 * <p> 32 * Example: 33 * <pre> 34 * {@literal @}Dao 35 * public interface MyDao { 36 * {@literal @}Delete 37 * public void deleteUsers(User... users); 38 * {@literal @}Delete 39 * public void deleteAll(User user1, User user2); 40 * {@literal @}Delete 41 * public void deleteWithFriends(User user, List<User> friends); 42 * } 43 * </pre> 44 * 45 * @see Insert 46 * @see Query 47 */ 48 @Target(ElementType.METHOD) 49 @Retention(RetentionPolicy.CLASS) 50 public @interface Delete { 51 } 52