001/*
002 * Copyright 2009-2014 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2009-2014 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.ldap.sdk.persist;
022
023
024
025import java.lang.annotation.ElementType;
026import java.lang.annotation.Documented;
027import java.lang.annotation.Retention;
028import java.lang.annotation.RetentionPolicy;
029import java.lang.annotation.Target;
030
031
032
033/**
034 * This annotation type may be used to mark a field whose value should be the
035 * full entry from which the corresponding object was initialized.  This
036 * annotation type should only be used for at most one field in a given class,
037 * and that class must be marked with the {@link LDAPObject} annotation type.
038 * The field marked with this annotation type must have a type of
039 * {@link com.unboundid.ldap.sdk.ReadOnlyEntry}.  Objects which may be altered
040 * using modify operations through the persistence framework should contain a
041 * field with this annotation to make it possible to accurately determine
042 * exactly what changes need to be made to the entry in the directory.
043 */
044@Documented()
045@Retention(RetentionPolicy.RUNTIME)
046@Target(value={ElementType.FIELD})
047public @interface LDAPEntryField
048{
049}