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.RetentionPolicy.CLASS;
023import static org.apiguardian.api.API.Status.INTERNAL;
024
025import java.lang.annotation.Documented;
026import java.lang.annotation.Retention;
027import java.lang.annotation.Target;
028
029import org.apiguardian.api.API;
030import org.tquadrat.foundation.annotation.ClassVersion;
031
032/**
033 *  <p>{@summary Excludes the value of the property belonging to annotated
034 *  getter from being included into the output of
035 *  {@link Object#toString()}.}</p>
036 *  <p>Sometimes it does not make sense to show the value of a property when
037 *  {@link Object#toString()}
038 *  is called on the configuration bean (or it is not wanted, that the value
039 *  is shown). In such a case, the getter for the property can be annotated
040 *  with this annotation, and
041 *  {@link org.tquadrat.foundation.lang.Stringer#BASE_STRINGER}
042 *  is used to show the property in the output of {@code toString()}.</p>
043 *
044 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
045 *  @version $Id: ExemptFromToString.java 884 2021-03-22 18:02:51Z tquadrat $
046 *  @since 0.0.2
047 *
048 *  @UMLGraph.link
049 */
050@ClassVersion( sourceVersion = "$Id: ExemptFromToString.java 884 2021-03-22 18:02:51Z tquadrat $" )
051@API( status = INTERNAL, since = "0.0.2" )
052@Retention( CLASS )
053@Target( METHOD )
054@Documented
055public @interface ExemptFromToString
056{ /* Empty */ }
057//  annotation ExemptFromToString
058
059/*
060 *  End of File
061 */