Better comments on JavaVersion

Fixes elastic#3452
ttyard · Jun 19, 2015 · b91f01e · b91f01e
1 parent 64b66fd
commit b91f01e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/logstash/util/java_version.rb b/lib/logstash/util/java_version.rb
@@ -17,6 +17,9 @@ def self.version
     System.getProperty("java.runtime.version")
   end
 
+  # Takes a string of a java version ex: "1.8.0_24-beta"
+  # and returns a parsed map of the components.
+  # nil inputs will be returned as nil.
   def self.parse_java_version(version_string)
     return nil if version_string.nil?
 
@@ -36,6 +39,9 @@ def self.parse_java_version(version_string)
     }
   end
 
+  # Determine if the given java version string is a bad version of java
+  # If it is, return true, if it isn't return false.
+  # Accepts nil, returning nil.
   def self.bad_java_version?(version_string)
     return nil if version_string.nil?