org.smooks.cartridges.persistence.scribe.annotation.Update Maven / Gradle / Ivy
/*-
* ========================LICENSE_START=================================
* Scribe :: Core
* %%
* Copyright (C) 2020 Smooks
* %%
* Licensed under the terms of the Apache License Version 2.0, or
* the GNU Lesser General Public License version 3.0 or later.
*
* SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later
*
* ======================================================================
*
* 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.
*
* ======================================================================
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* =========================LICENSE_END==================================
*/
package org.smooks.cartridges.persistence.scribe.annotation;
import org.smooks.scribe.annotation.Dao;
import org.smooks.scribe.annotation.Delete;
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 this method updates entities.
*
* The method must have only one parameter. This parameter is
* for the entity that is going to be updated.
*
* This annotation should only be used on classes that
* are annotated with the {@link Dao} annotation.
*
* @author [email protected]
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Update {
/**
* The name of the update operation. If it is not set then
* the name of the method will be the name of the operation.
*
* @return the operation name
*/
String name() default "";
/**
* If this method is the default update method of the DAO.
* Only one method can be set to the default update method.
* If only one method with the {@link Delete} annotation is
* present then that method is automatically the default method.
*
* @return if the method is the default update method
*/
boolean isDefault() default false;
}