Module org.tquadrat.foundation.base
Package org.tquadrat.foundation.annotation

Annotation Interface ClassVersion

@Documented @Retention(RUNTIME) @Target(TYPE) @API(status=STABLE, since="0.0.5") public @interface ClassVersion

This annotation will be used to provide version information for each class in a project. It can provide source code (SCCS) related version information as well as release related information (Build number and Release numbers).

Keep in mind that neither versionNumber() nor buildNumber() need to be numbers according to the syntax rules for numerical values.

Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: ClassVersion.java 966 2022-01-04 22:28:49Z tquadrat $
Since:
0.0.5

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    sourceVersion
    Returns the source version, usually as delivered by the SCCS.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    buildNumber
    Returns the build number, usually injected during the build by the build tool.
    boolean
    isGenerated
    Returns true if the class was generated by any kind of Source Code generator.
    String
    versionNumber
    Returns the version number, usually injected during the build by the build tool.

  • Element Details

    • buildNumber

      String buildNumber
      Returns the build number, usually injected during the build by the build tool. The default is the empty string.
      Returns:
      The build number.
      Default:
      ""

    • isGenerated

      boolean isGenerated
      Returns true if the class was generated by any kind of Source Code generator.
      Returns:
      false (the default) if the class was manually implemented, true otherwise.
      Default:
      false

    • sourceVersion

      String sourceVersion
      Returns the source version, usually as delivered by the SCCS.
      Returns:
      The version of the source code.

    • versionNumber

      String versionNumber
      Returns the version number, usually injected during the build by the build tool. The default is the empty string.
      Returns:
      The version number.
      Default:
      ""