Class FreeplaneVersion

java.lang.Object
org.freeplane.core.util.FreeplaneVersion
All Implemented Interfaces:
java.lang.Comparable<FreeplaneVersion>, FreeplaneVersion

public class FreeplaneVersion
extends java.lang.Object
implements FreeplaneVersion
provides access to the current Freeplane version. In scripts use c.freeplaneVersion. For usage instructions see compareTo(org.freeplane.api.FreeplaneVersion).
  • Field Details

  • Constructor Details

    • FreeplaneVersion

      public FreeplaneVersion​(int pMaj, int pMid, int pMin, java.lang.String pType, int pNum)
    • FreeplaneVersion

      public FreeplaneVersion​(int pMaj, int pMid, int pMin)
  • Method Details

    • getVersion

      public static FreeplaneVersion getVersion()
    • getVersion

      public static FreeplaneVersion getVersion​(java.lang.String pString) throws java.lang.IllegalArgumentException
      Parses a version string as FreeplaneVersion. Ignores leading 'v' (e.g. "v1.2.6") and accept '.' and ' ' as separator.
      Throws:
      java.lang.IllegalArgumentException - on parse errors
    • getMaj

      public int getMaj()
      Specified by:
      getMaj in interface FreeplaneVersion
    • getMid

      public int getMid()
      Specified by:
      getMid in interface FreeplaneVersion
    • getMin

      public int getMin()
      Specified by:
      getMin in interface FreeplaneVersion
    • getNum

      public int getNum()
      Specified by:
      getNum in interface FreeplaneVersion
    • getType

      public java.lang.String getType()
      Specified by:
      getType in interface FreeplaneVersion
    • getRevision

      public java.lang.String getRevision()
      Specified by:
      getRevision in interface FreeplaneVersion
    • compareTo

      public int compareTo​(FreeplaneVersion o)
      Use it like this:
         import org.freeplane.core.util.FreeplaneVersion
         def required = FreeplaneVersion.getVersion("1.2.20")
         if (c.freeplaneVersion < required)
             ui.errorMessage("Freeplane version ${c.freeplaneVersion}"
                 + " not supported - update to at least ${required}")
       
      Specified by:
      compareTo in interface java.lang.Comparable<FreeplaneVersion>
    • toString

      public java.lang.String toString()
      returns the full version number, e.g. "1.0.38 rc".
      Overrides:
      toString in class java.lang.Object
    • numberToString

      public java.lang.String numberToString()
      returns the version number only, e.g. "1.0.38".
      Specified by:
      numberToString in interface FreeplaneVersion
    • isOlderThan

      public boolean isOlderThan​(FreeplaneVersion freeplaneVersion)
      Specified by:
      isOlderThan in interface FreeplaneVersion
    • isNewerThan

      public boolean isNewerThan​(FreeplaneVersion freeplaneVersion)
      Specified by:
      isNewerThan in interface FreeplaneVersion
    • isFinal

      public boolean isFinal()
      Specified by:
      isFinal in interface FreeplaneVersion