Michael Bayne
65 lines
2.5 KiB
Java
65 lines
2.5 KiB
Java
//
|
|
// $Id$
|
|
//
|
|
// Depot library - a Java relational persistence library
|
|
// Copyright (C) 2006-2008 Michael Bayne and Pär Winzell
|
|
//
|
|
// This library 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 2.1 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This library 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 library; if not, write to the Free Software
|
|
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
package com.samskivert.depot.annotation;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
|
|
/**
|
|
* Provides for the specification of generation strategies for the values of primary keys. The
|
|
* GeneratedValue annotation may be applied to a primary field in conjunction with the {@link Id}
|
|
* annotation.
|
|
*/
|
|
@Target(value=ElementType.FIELD)
|
|
@Retention(value=RetentionPolicy.RUNTIME)
|
|
public @interface GeneratedValue
|
|
{
|
|
/** Identifies which generator should be used to generate this value when using a table or
|
|
* sequence generator. */
|
|
String generator () default "";
|
|
|
|
/** Identifies the strategy to be used to generate this value. */
|
|
GenerationType strategy () default GenerationType.AUTO;
|
|
|
|
/**
|
|
* The initial value to be used when allocating id numbers from the generator. The default
|
|
* initial value is 1. <em>Note:</em> this default differs from the value used by the EJB3
|
|
* persistence framework.
|
|
*/
|
|
int initialValue () default 1;
|
|
|
|
/**
|
|
* If there are rows in our corresponding table, this boolean determines whether or not to
|
|
* attempt to initialize the generator to the maximum value of our associated field over
|
|
* those rows. This attribute does not exist in the EJB3 framework.
|
|
*/
|
|
boolean migrateIfExists () default true;
|
|
|
|
/**
|
|
* The amount to increment by when allocating id numbers from the generator. The default
|
|
* allocation size is 1. <em>Note:</em> this default differs from the value used by the EJB3
|
|
* persistence framework.
|
|
*/
|
|
int allocationSize () default 1;
|
|
}
|