Uploaded image for project: 'Commons Collections'
  1. Commons Collections
  2. COLLECTIONS-749

Better documentation needed for HashFunctionIdentity.Signedness

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 4.5
    • Fix Version/s: None
    • Component/s: Collection
    • Labels:
      None

      Description

      From Alex Herbert:

      HashFunctionIdentity.Signedness

      This is not fully documented as to what the sign applies to. There is no
      javadoc on the enum values for SIGNED and UNSIGNED. The current javadoc
      states "Identifies the signedness of the calculations for this function".

      I assume this applies to the Hash computation in 'long
      HashFunction.apply(byte[], int)'

      Does this mean the hash algorithm has a variant that can treat the
      bytes/seed as signed or unsigned. If so which one because 2 enum values
      cannot cover all 4 possibilities. Since there is no javadoc it is
      unclear exactly what this property is supposed to indicate.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              claude Claude Warren
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 20m
                20m