Metadatas (GIT versioning using jgit 0.10.2 API)

java.lang.Object
- java.lang.Enum<Metadatas>
- - fr.brouillard.oss.jgitver.metadata.Metadatas

All Implemented Interfaces:

Serializable, Comparable<Metadatas>
```
public enum Metadatas
extends Enum<Metadatas>
```
Enumeration of all the possible metadata that GitVersionCalculator can provide for a repository.

Author:

Matthieu Brouillard

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL_ANNOTATED_TAGS` Corresponds to the whole list of annotated tags of the current repository.
`ALL_LIGHTWEIGHT_TAGS` Corresponds to the whole list of light tags of the current repository.
`ALL_TAGS` Corresponds to the whole list of tags of the current repository.
`ALL_VERSION_ANNOTATED_TAGS` Corresponds to the whole list of annotated tags of the current repository that can serve for version calculation.
`ALL_VERSION_LIGHTWEIGHT_TAGS` Corresponds to the whole list of light tags of the current repository that can serve for version calculation.
`ALL_VERSION_TAGS` Corresponds to the whole list of tags that can serve for version calculation.
`BASE_TAG` Corresponds to the base tag that was used for the version calculation.
`BASE_TAG_TYPE` Corresponds to the type of tag that was used for the version calculation.
`BASE_VERSION` Exposes the version used to base the calculation on for the retained version.
`BRANCH_NAME` Corresponds to the current branch name if any.
`CALCULATED_VERSION` The calculated version.
`COMMIT_DISTANCE` Exposes the commit distance from the base tag used for the version computation.
`COMMIT_TIMESTAMP` Exposes the commit timestamp instant in the current system timezone using a simplified DateTimeFormatter.ISO_LOCAL_DATE_TIME
`CURRENT_VERSION_MAJOR` Exposes the major version of the computed version, ie the X in X.Y.Z.
`CURRENT_VERSION_MINOR` Exposes the minor version of the computed version, ie the Y in X.Y.Z.
`CURRENT_VERSION_PATCH` Exposes the patch version of the computed version, ie the Z in X.Y.Z.
`DIRTY` Is the repository dirty.
`GIT_SHA1_8` Corresponds to a substring of the git identifier of the HEAD.
`GIT_SHA1_FULL` Corresponds to then the full git identifier of the HEAD.
`HEAD_ANNOTATED_TAGS` Corresponds to the list of annotated tags, associated with the current HEAD.
`HEAD_COMMIT_DATETIME` Datetime of the commit.
`HEAD_COMMITER_EMAIL` Email of the commiter of HEAD commit.
`HEAD_COMMITTER_NAME` Name of the commiter of HEAD commit.
`HEAD_LIGHTWEIGHT_TAGS` Corresponds to the list of light tags, associated with the current HEAD.
`HEAD_TAGS` Corresponds to the list of tags, associated with the current HEAD.
`HEAD_VERSION_ANNOTATED_TAGS` Corresponds to the list of annotated tags, eligible as version, associated with the current HEAD.
`HEAD_VERSION_LIGHTWEIGHT_TAGS` Corresponds to the list of light tags, eligible as version, associated with the current HEAD.
`HEAD_VERSION_TAGS` Corresponds to the list of tags, eligible as version, associated with the current HEAD.
`NEXT_MAJOR_VERSION` Exposes the next calculated version by adding one to the major digit of the current retained version.
`NEXT_MINOR_VERSION` Exposes the next calculated version by adding one to the minor digit of the current retained version.
`NEXT_PATCH_VERSION` Exposes the next calculated version by adding one to the patch digit of the current retained version.
`QUALIFIED_BRANCH_NAME` Branch name used as a qualifier if any.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Metadatas`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Metadatas[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CALCULATED_VERSION
```
public static final Metadatas CALCULATED_VERSION
```
    The calculated version.
  - DIRTY
```
public static final Metadatas DIRTY
```
    Is the repository dirty.
  - HEAD_COMMITTER_NAME
```
public static final Metadatas HEAD_COMMITTER_NAME
```
    Name of the commiter of HEAD commit.
  - HEAD_COMMITER_EMAIL
```
public static final Metadatas HEAD_COMMITER_EMAIL
```
    Email of the commiter of HEAD commit.
  - HEAD_COMMIT_DATETIME
```
public static final Metadatas HEAD_COMMIT_DATETIME
```
    Datetime of the commit.
  - GIT_SHA1_FULL
```
public static final Metadatas GIT_SHA1_FULL
```
    Corresponds to then the full git identifier of the HEAD.
  - GIT_SHA1_8
```
public static final Metadatas GIT_SHA1_8
```
    Corresponds to a substring of the git identifier of the HEAD.
  - BRANCH_NAME
```
public static final Metadatas BRANCH_NAME
```
    Corresponds to the current branch name if any.
  - QUALIFIED_BRANCH_NAME
```
public static final Metadatas QUALIFIED_BRANCH_NAME
```
    Branch name used as a qualifier if any.
  - HEAD_TAGS
```
public static final Metadatas HEAD_TAGS
```
    Corresponds to the list of tags, associated with the current HEAD.
  - HEAD_ANNOTATED_TAGS
```
public static final Metadatas HEAD_ANNOTATED_TAGS
```
    Corresponds to the list of annotated tags, associated with the current HEAD.
  - HEAD_LIGHTWEIGHT_TAGS
```
public static final Metadatas HEAD_LIGHTWEIGHT_TAGS
```
    Corresponds to the list of light tags, associated with the current HEAD.
  - HEAD_VERSION_TAGS
```
public static final Metadatas HEAD_VERSION_TAGS
```
    Corresponds to the list of tags, eligible as version, associated with the current HEAD.
  - HEAD_VERSION_ANNOTATED_TAGS
```
public static final Metadatas HEAD_VERSION_ANNOTATED_TAGS
```
    Corresponds to the list of annotated tags, eligible as version, associated with the current HEAD.
  - HEAD_VERSION_LIGHTWEIGHT_TAGS
```
public static final Metadatas HEAD_VERSION_LIGHTWEIGHT_TAGS
```
    Corresponds to the list of light tags, eligible as version, associated with the current HEAD.
  - BASE_TAG
```
public static final Metadatas BASE_TAG
```
    Corresponds to the base tag that was used for the version calculation.
  - BASE_TAG_TYPE
```
public static final Metadatas BASE_TAG_TYPE
```
    Corresponds to the type of tag that was used for the version calculation. Value taken from TagType.
  - ALL_TAGS
```
public static final Metadatas ALL_TAGS
```
    Corresponds to the whole list of tags of the current repository.
  - ALL_ANNOTATED_TAGS
```
public static final Metadatas ALL_ANNOTATED_TAGS
```
    Corresponds to the whole list of annotated tags of the current repository.
  - ALL_LIGHTWEIGHT_TAGS
```
public static final Metadatas ALL_LIGHTWEIGHT_TAGS
```
    Corresponds to the whole list of light tags of the current repository.
  - ALL_VERSION_TAGS
```
public static final Metadatas ALL_VERSION_TAGS
```
    Corresponds to the whole list of tags that can serve for version calculation.
  - ALL_VERSION_ANNOTATED_TAGS
```
public static final Metadatas ALL_VERSION_ANNOTATED_TAGS
```
    Corresponds to the whole list of annotated tags of the current repository that can serve for version calculation.
  - ALL_VERSION_LIGHTWEIGHT_TAGS
```
public static final Metadatas ALL_VERSION_LIGHTWEIGHT_TAGS
```
    Corresponds to the whole list of light tags of the current repository that can serve for version calculation.
  - NEXT_MAJOR_VERSION
```
public static final Metadatas NEXT_MAJOR_VERSION
```
    Exposes the next calculated version by adding one to the major digit of the current retained version.
  - NEXT_MINOR_VERSION
```
public static final Metadatas NEXT_MINOR_VERSION
```
    Exposes the next calculated version by adding one to the minor digit of the current retained version.
  - NEXT_PATCH_VERSION
```
public static final Metadatas NEXT_PATCH_VERSION
```
    Exposes the next calculated version by adding one to the patch digit of the current retained version.
  - BASE_VERSION
```
public static final Metadatas BASE_VERSION
```
    Exposes the version used to base the calculation on for the retained version.
  - CURRENT_VERSION_MAJOR
```
public static final Metadatas CURRENT_VERSION_MAJOR
```
    Exposes the major version of the computed version, ie the X in X.Y.Z.
  - CURRENT_VERSION_MINOR
```
public static final Metadatas CURRENT_VERSION_MINOR
```
    Exposes the minor version of the computed version, ie the Y in X.Y.Z.
  - CURRENT_VERSION_PATCH
```
public static final Metadatas CURRENT_VERSION_PATCH
```
    Exposes the patch version of the computed version, ie the Z in X.Y.Z.
  - COMMIT_DISTANCE
```
public static final Metadatas COMMIT_DISTANCE
```
    Exposes the commit distance from the base tag used for the version computation.
  - COMMIT_TIMESTAMP
```
public static final Metadatas COMMIT_TIMESTAMP
```
    Exposes the commit timestamp instant in the current system timezone using a simplified DateTimeFormatter.ISO_LOCAL_DATE_TIME
- Method Detail
  - values
```
public static Metadatas[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Metadatas c : Metadatas.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Metadatas valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum Metadatas

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CALCULATED_VERSION

DIRTY

HEAD_COMMITTER_NAME

HEAD_COMMITER_EMAIL

HEAD_COMMIT_DATETIME

GIT_SHA1_FULL

GIT_SHA1_8

BRANCH_NAME

QUALIFIED_BRANCH_NAME

HEAD_TAGS

HEAD_ANNOTATED_TAGS

HEAD_LIGHTWEIGHT_TAGS

HEAD_VERSION_TAGS

HEAD_VERSION_ANNOTATED_TAGS

HEAD_VERSION_LIGHTWEIGHT_TAGS

BASE_TAG

BASE_TAG_TYPE

ALL_TAGS

ALL_ANNOTATED_TAGS

ALL_LIGHTWEIGHT_TAGS

ALL_VERSION_TAGS

ALL_VERSION_ANNOTATED_TAGS

ALL_VERSION_LIGHTWEIGHT_TAGS

NEXT_MAJOR_VERSION

NEXT_MINOR_VERSION

NEXT_PATCH_VERSION

BASE_VERSION

CURRENT_VERSION_MAJOR

CURRENT_VERSION_MINOR

CURRENT_VERSION_PATCH

COMMIT_DISTANCE

COMMIT_TIMESTAMP

Method Detail

values

valueOf