androidx.room.Insert Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
/*
* Copyright (C) 2016 The Android Open Source Project
*
* 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 androidx.room;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marks a method in a {@link Dao} annotated class as an insert method.
*
* The implementation of the method will insert its parameters into the database.
*
* All of the parameters of the Insert method must either be classes annotated with {@link Entity}
* or collections/array of it.
*
* Example:
*
* {@literal @}Dao
* public interface MyDao {
* {@literal @}Insert(onConflict = OnConflictStrategy.REPLACE)
* public void insertUsers(User... users);
* {@literal @}Insert
* public void insertBoth(User user1, User user2);
* {@literal @}Insert
* public void insertWithFriends(User user, List<User> friends);
* }
*
*
* @see Update
* @see Delete
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.CLASS)
public @interface Insert {
/**
* What to do if a conflict happens.
* @see SQLite conflict documentation
*
* @return How to handle conflicts. Defaults to {@link OnConflictStrategy#ABORT}.
*/
@OnConflictStrategy
int onConflict() default OnConflictStrategy.ABORT;
}