Class DeweyDecimal

  • All Implemented Interfaces:
    java.lang.Comparable<DeweyDecimal>
    Direct Known Subclasses:
    DeweyDecimal

    public class DeweyDecimal
    extends java.lang.Object
    implements java.lang.Comparable<DeweyDecimal>
    Utility class to contain version numbers in "Dewey Decimal" syntax. Numbers in the "Dewey Decimal" syntax consist of positive decimal integers separated by periods ".". For example, "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc versions. The version number must begin with a number.
    • Constructor Summary

      Constructors 
      Constructor Description
      DeweyDecimal​(int[] components)
      Construct a DeweyDecimal from an array of integer components.
      DeweyDecimal​(java.lang.String string)
      Construct a DeweyDecimal from string in DeweyDecimal format.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(DeweyDecimal other)
      Compares this DeweyDecimal with another one.
      boolean equals​(java.lang.Object o)  
      int get​(int index)
      Return the component at specified index.
      int getSize()
      Return number of components in DeweyDecimal.
      int hashCode()  
      boolean isEqual​(DeweyDecimal other)
      Return true if this DeweyDecimal is equal to the other DeweyDecimal.
      boolean isGreaterThan​(DeweyDecimal other)
      Return true if this DeweyDecimal is greater than the other DeweyDecimal.
      boolean isGreaterThanOrEqual​(DeweyDecimal other)
      Return true if this DeweyDecimal is greater than or equal to the other DeweyDecimal.
      boolean isLessThan​(DeweyDecimal other)
      Return true if this DeweyDecimal is less than the other DeweyDecimal.
      boolean isLessThanOrEqual​(DeweyDecimal other)
      Return true if this DeweyDecimal is less than or equal to the other DeweyDecimal.
      java.lang.String toString()
      Return string representation of DeweyDecimal.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DeweyDecimal

        public DeweyDecimal​(int[] components)
        Construct a DeweyDecimal from an array of integer components.
        Parameters:
        components - an array of integer components.
      • DeweyDecimal

        public DeweyDecimal​(java.lang.String string)
                     throws java.lang.NumberFormatException
        Construct a DeweyDecimal from string in DeweyDecimal format.
        Parameters:
        string - the string in dewey decimal format
        Throws:
        java.lang.NumberFormatException - if string is malformed
    • Method Detail

      • getSize

        public int getSize()
        Return number of components in DeweyDecimal.
        Returns:
        the number of components in dewey decimal
      • get

        public int get​(int index)
        Return the component at specified index.
        Parameters:
        index - the index of components
        Returns:
        the value of component at index
      • isEqual

        public boolean isEqual​(DeweyDecimal other)
        Return true if this DeweyDecimal is equal to the other DeweyDecimal.
        Parameters:
        other - the other DeweyDecimal
        Returns:
        true if equal to other DeweyDecimal, false otherwise
      • isLessThan

        public boolean isLessThan​(DeweyDecimal other)
        Return true if this DeweyDecimal is less than the other DeweyDecimal.
        Parameters:
        other - the other DeweyDecimal
        Returns:
        true if less than other DeweyDecimal, false otherwise
      • isLessThanOrEqual

        public boolean isLessThanOrEqual​(DeweyDecimal other)
        Return true if this DeweyDecimal is less than or equal to the other DeweyDecimal.
        Parameters:
        other - the other DeweyDecimal
        Returns:
        true if less than or equal to other DeweyDecimal, false otherwise
      • isGreaterThan

        public boolean isGreaterThan​(DeweyDecimal other)
        Return true if this DeweyDecimal is greater than the other DeweyDecimal.
        Parameters:
        other - the other DeweyDecimal
        Returns:
        true if greater than other DeweyDecimal, false otherwise
      • isGreaterThanOrEqual

        public boolean isGreaterThanOrEqual​(DeweyDecimal other)
        Return true if this DeweyDecimal is greater than or equal to the other DeweyDecimal.
        Parameters:
        other - the other DeweyDecimal
        Returns:
        true if greater than or equal to other DeweyDecimal, false otherwise
      • toString

        public java.lang.String toString()
        Return string representation of DeweyDecimal.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation of DeweyDecimal.
      • compareTo

        public int compareTo​(DeweyDecimal other)
        Compares this DeweyDecimal with another one.
        Specified by:
        compareTo in interface java.lang.Comparable<DeweyDecimal>
        Parameters:
        other - another DeweyDecimal to compare with
        Returns:
        result
        See Also:
        Comparable.compareTo(Object)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object