001/*
002 * ============================================================================
003 * Copyright © 2002-2022 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.annotation;
019
020import static java.lang.annotation.ElementType.TYPE;
021import static java.lang.annotation.RetentionPolicy.RUNTIME;
022import static org.apiguardian.api.API.Status.STABLE;
023
024import java.lang.annotation.Documented;
025import java.lang.annotation.Retention;
026import java.lang.annotation.Target;
027
028import org.apiguardian.api.API;
029
030/**
031 *  <p>{@summary This annotation will be used to provide version information
032 *  for each class in a project.} It can provide source code (SCCS) related
033 *  version information as well as release related information (Build number
034 *  and Release numbers).</p>
035 *  <p>Keep in mind that neither
036 *  {@link #versionNumber()}
037 *  nor
038 *  {@link #buildNumber()}
039 *  need to be numbers according to the syntax rules for numerical values.</p>
040 *
041 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
042 *  @version $Id: ClassVersion.java 966 2022-01-04 22:28:49Z tquadrat $
043 *  @since 0.0.5
044 */
045@Documented
046@Retention( RUNTIME )
047@Target( TYPE )
048@API( status = STABLE, since = "0.0.5" )
049public @interface ClassVersion
050{
051        /*------------*\
052    ====** Attributes **=======================================================
053        \*------------*/
054    /**
055     *  Returns the build number, usually injected during the build by the
056     *  build tool. The default is the empty string.
057     *
058     *  @return The build number.
059     */
060    String buildNumber() default "";
061
062    /**
063     *  Returns {@code true} if the class was generated by any kind of
064     *  Source Code generator.
065     *
066     *  @return {@code false} (the default) if the class was manually
067     *      implemented, {@code true} otherwise.
068     */
069    boolean isGenerated() default false;
070
071    /**
072     *  Returns the source version, usually as delivered by the SCCS.
073     *
074     *  @return The version of the source code.
075     */
076    String sourceVersion();
077
078    /**
079     *  Returns the version number, usually injected during the build by the
080     *  build tool. The default is the empty string.
081     *
082     *  @return The version number.
083     */
084    String versionNumber() default "";
085}
086//  @interface ClassVersion
087
088/*
089 *  End of File
090 */