001/*
002 * ============================================================================
003 * Copyright © 2002-2021 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.config;
020
021import static java.lang.annotation.ElementType.METHOD;
022import static java.lang.annotation.ElementType.TYPE;
023import static java.lang.annotation.RetentionPolicy.CLASS;
024import static org.apiguardian.api.API.Status.STABLE;
025
026import java.lang.annotation.Documented;
027import java.lang.annotation.Retention;
028import java.lang.annotation.Target;
029
030import org.apiguardian.api.API;
031import org.tquadrat.foundation.annotation.ClassVersion;
032
033/**
034 *  <p>{@summary Excludes the property from having a preferences
035 *  reference.}</p>
036 *  <p>If a configuration bean specification implements the interface
037 *  {@link PreferencesBeanSpec},
038 *  usually all the properties do have references to a preferences
039 *  instance.</p>
040 *  <p>If applied to the property's getter method, this annotation is used to
041 *  exclude the annotated property from the preferences.</p>
042 *
043 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
044 *  @version $Id: NoPreference.java 941 2021-12-18 22:34:37Z tquadrat $
045 *  @since 0.0.1
046 */
047@ClassVersion( sourceVersion = "$Id: NoPreference.java 941 2021-12-18 22:34:37Z tquadrat $" )
048@Documented
049@Retention( CLASS )
050@Target( {METHOD, TYPE} )
051@API( status = STABLE, since = "0.0.1" )
052public @interface NoPreference
053{ /* Empty */ }
054//  annotation NoPreference
055
056/*
057 *  End of File
058 */