org.datanucleus.api.jdo.annotations.UpdateUser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of datanucleus-api-jdo Show documentation

Plugin providing DataNucleus implementation of the JDO API.

There is a newer version: 6.0.4

/**********************************************************************
Copyright (c) 2017 Andy Jefferson and others. All rights reserved.
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.

Contributors:
    ...
**********************************************************************/
package org.datanucleus.api.jdo.annotations;

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

/**
 * Extension annotation specifying either this field/method or use a surrogate column as storing the update user for this object.
 * Only applies if specified on a String.
 */
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE}) 
@Retention(RetentionPolicy.RUNTIME)
public @interface UpdateUser
{
    /**
     * Name of the update user column in the table for this class when this is a surrogate (class-level) column.
     * @return The update user column name
     */
    String column() default "UPDATE_USER";

    /**
     * Length of the update user column.
     * @return Length of the update user column.
     */
    int columnLength() default -1;
}