Package ca.solostudios.strata.version

Class BuildMetadata

  • All Implemented Interfaces:
    Formattable
    public final class BuildMetadata
extends java.lang.Object
implements Formattable
    A class representing the build metadata of a Version

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static BuildMetadata NULL
      An empty build metadata instance used it no metadata is provided.

    • Constructor Summary

      Constructors 
      Constructor Description
      BuildMetadata​(@NotNull java.lang.String buildMetadata)
      Constructs a new build metadata

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      @NotNull java.lang.String getBuildMetadata()
      The build metadata as a string.
      @NotNull java.lang.String getFormatted()
      This object represented as a short and human readable string.
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • NULL

        public static final BuildMetadata NULL
        An empty build metadata instance used it no metadata is provided.

    • Constructor Detail

      • BuildMetadata

        @Contract(pure=true)
public BuildMetadata​(@NotNull
                     @NotNull java.lang.String buildMetadata)
        Constructs a new build metadata
        Parameters:
        buildMetadata - The build metadata string to store.

    • Method Detail

      • getBuildMetadata

        @NotNull
@Contract(pure=true)
public @NotNull java.lang.String getBuildMetadata()
        The build metadata as a string.
        Returns:
        The build metadata

      • toString

        @Contract(pure=true)
public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        @Contract(pure=true)
public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        @Contract(pure=true)
public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getFormatted

        @NotNull
public @NotNull java.lang.String getFormatted()
        Description copied from interface: Formattable
        This object represented as a short and human readable string.
        Specified by:
        getFormatted in interface Formattable
        Returns:
        This object as a readable string.