blob: 51bef9283d1223d3cbc1a70d0f4dd7b40cc814eb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"></a>
<span class="sourceLineNo">010</span><a id="line.10"> http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"></a>
<span class="sourceLineNo">012</span><a id="line.12"> Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19"></a>
<span class="sourceLineNo">020</span><a id="line.20">package org.apache.wiki.api;</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">/**</a>
<span class="sourceLineNo">026</span><a id="line.26"> * Contains release and version information. You may also invoke this class directly, in which case it prints</a>
<span class="sourceLineNo">027</span><a id="line.27"> * out the version string. This is a handy way of checking which JSPWiki version you have - just type from a command line:</a>
<span class="sourceLineNo">028</span><a id="line.28"> * &lt;pre&gt;</a>
<span class="sourceLineNo">029</span><a id="line.29"> * % java -cp JSPWiki.jar org.apache.wiki.api.Release</a>
<span class="sourceLineNo">030</span><a id="line.30"> * 2.5.38</a>
<span class="sourceLineNo">031</span><a id="line.31"> * &lt;/pre&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> * &lt;p&gt;</a>
<span class="sourceLineNo">033</span><a id="line.33"> * As a historical curiosity, this is the oldest JSPWiki file. According to the CVS history, it dates from 6.7.2001, and it really hasn't</a>
<span class="sourceLineNo">034</span><a id="line.34"> * changed much since.</a>
<span class="sourceLineNo">035</span><a id="line.35"> * &lt;/p&gt;</a>
<span class="sourceLineNo">036</span><a id="line.36"> * @since 1.0</a>
<span class="sourceLineNo">037</span><a id="line.37"> */</a>
<span class="sourceLineNo">038</span><a id="line.38">public final class Release {</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> private static final String VERSION_SEPARATORS = ".-";</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> /**</a>
<span class="sourceLineNo">043</span><a id="line.43"> * This is the default application name.</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45"> public static final String APPNAME = "JSPWiki";</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> /**</a>
<span class="sourceLineNo">048</span><a id="line.48"> * This should be empty when doing a release - otherwise keep it as "-git-" so that whenever someone checks out the code, they know</a>
<span class="sourceLineNo">049</span><a id="line.49"> * it is a bleeding-edge version. Other possible values are "-alpha-" and "-beta-" for alpha and beta versions, respectively.</a>
<span class="sourceLineNo">050</span><a id="line.50"> * &lt;p&gt;</a>
<span class="sourceLineNo">051</span><a id="line.51"> * If the POSTFIX is empty, it is not added to the version string.</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53"> private static final String POSTFIX = "-git-";</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> /** The JSPWiki major version. */</a>
<span class="sourceLineNo">056</span><a id="line.56"> public static final int VERSION = 2;</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> /** The JSPWiki revision. */</a>
<span class="sourceLineNo">059</span><a id="line.59"> public static final int REVISION = 12;</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> /** The minor revision. */</a>
<span class="sourceLineNo">062</span><a id="line.62"> public static final int MINORREVISION = 2;</a>
<span class="sourceLineNo">063</span><a id="line.63"></a>
<span class="sourceLineNo">064</span><a id="line.64"> /** The build number/identifier. This is a String as opposed to an integer, just so that people can add other identifiers to it.</a>
<span class="sourceLineNo">065</span><a id="line.65"> * The build number is incremented every time a committer checks in code, and reset when a release is made.</a>
<span class="sourceLineNo">066</span><a id="line.66"> * &lt;p&gt;</a>
<span class="sourceLineNo">067</span><a id="line.67"> * If you are a person who likes to build his own releases, we recommend that you add your initials to this</a>
<span class="sourceLineNo">068</span><a id="line.68"> * identifier (e.g. "13-jj", or "49-aj").</a>
<span class="sourceLineNo">069</span><a id="line.69"> * &lt;p&gt;</a>
<span class="sourceLineNo">070</span><a id="line.70"> * If the build identifier is empty, it is not added.</a>
<span class="sourceLineNo">071</span><a id="line.71"> */</a>
<span class="sourceLineNo">072</span><a id="line.72"> public static final String BUILD = "14";</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> /**</a>
<span class="sourceLineNo">075</span><a id="line.75"> * This is the generic version string you should use when printing out the version. It is of</a>
<span class="sourceLineNo">076</span><a id="line.76"> * the form "VERSION.REVISION.MINORREVISION[-POSTFIX][-BUILD]".</a>
<span class="sourceLineNo">077</span><a id="line.77"> */</a>
<span class="sourceLineNo">078</span><a id="line.78"> public static final String VERSTR = VERSION + "." +</a>
<span class="sourceLineNo">079</span><a id="line.79"> REVISION + "." +</a>
<span class="sourceLineNo">080</span><a id="line.80"> MINORREVISION +</a>
<span class="sourceLineNo">081</span><a id="line.81"> POSTFIX +</a>
<span class="sourceLineNo">082</span><a id="line.82"> BUILD;</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> /** Private constructor prevents instantiation. */</a>
<span class="sourceLineNo">085</span><a id="line.85"> private Release() {</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> /**</a>
<span class="sourceLineNo">089</span><a id="line.89"> * This method is useful for templates, because hopefully it will not be inlined, and thus any change to version number does not</a>
<span class="sourceLineNo">090</span><a id="line.90"> * need recompiling the pages.</a>
<span class="sourceLineNo">091</span><a id="line.91"> *</a>
<span class="sourceLineNo">092</span><a id="line.92"> * @since 2.1.26.</a>
<span class="sourceLineNo">093</span><a id="line.93"> * @return The version string (e.g. 2.5.23).</a>
<span class="sourceLineNo">094</span><a id="line.94"> */</a>
<span class="sourceLineNo">095</span><a id="line.95"> public static String getVersionString() {</a>
<span class="sourceLineNo">096</span><a id="line.96"> return VERSTR;</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</a>
<span class="sourceLineNo">098</span><a id="line.98"></a>
<span class="sourceLineNo">099</span><a id="line.99"> /**</a>
<span class="sourceLineNo">100</span><a id="line.100"> * Returns true, if this version of JSPWiki is newer or equal than what is requested.</a>
<span class="sourceLineNo">101</span><a id="line.101"> *</a>
<span class="sourceLineNo">102</span><a id="line.102"> * @param version A version parameter string (a.b.c-something). B and C are optional.</a>
<span class="sourceLineNo">103</span><a id="line.103"> * @return A boolean value describing whether the given version is newer than the current JSPWiki.</a>
<span class="sourceLineNo">104</span><a id="line.104"> * @since 2.4.57</a>
<span class="sourceLineNo">105</span><a id="line.105"> * @throws IllegalArgumentException If the version string could not be parsed.</a>
<span class="sourceLineNo">106</span><a id="line.106"> */</a>
<span class="sourceLineNo">107</span><a id="line.107"> public static boolean isNewerOrEqual( final String version ) throws IllegalArgumentException {</a>
<span class="sourceLineNo">108</span><a id="line.108"> if( version == null ) {</a>
<span class="sourceLineNo">109</span><a id="line.109"> return true;</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"> final String[] versionComponents = StringUtils.split( version, VERSION_SEPARATORS );</a>
<span class="sourceLineNo">112</span><a id="line.112"> final int versionCompoLength = versionComponents.length;</a>
<span class="sourceLineNo">113</span><a id="line.113"> final int reqVersion = versionCompoLength &gt; 0 ? Integer.parseInt( versionComponents[0] ) : Release.VERSION;</a>
<span class="sourceLineNo">114</span><a id="line.114"> final int reqRevision = versionCompoLength &gt; 1 ? Integer.parseInt( versionComponents[1] ) : Release.REVISION;</a>
<span class="sourceLineNo">115</span><a id="line.115"> final int reqMinorRevision = versionCompoLength &gt; 2 ? Integer.parseInt( versionComponents[2] ) : Release.MINORREVISION;</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> if( VERSION == reqVersion ) {</a>
<span class="sourceLineNo">118</span><a id="line.118"> if( REVISION == reqRevision ) {</a>
<span class="sourceLineNo">119</span><a id="line.119"> if( MINORREVISION == reqMinorRevision ) {</a>
<span class="sourceLineNo">120</span><a id="line.120"> return true;</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"> return MINORREVISION &gt; reqMinorRevision;</a>
<span class="sourceLineNo">123</span><a id="line.123"> }</a>
<span class="sourceLineNo">124</span><a id="line.124"> return REVISION &gt; reqRevision;</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"> return VERSION &gt; reqVersion;</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> /**</a>
<span class="sourceLineNo">130</span><a id="line.130"> * Returns true, if this version of JSPWiki is older or equal than what is requested.</a>
<span class="sourceLineNo">131</span><a id="line.131"> *</a>
<span class="sourceLineNo">132</span><a id="line.132"> * @param version A version parameter string (a.b.c-something)</a>
<span class="sourceLineNo">133</span><a id="line.133"> * @return A boolean value describing whether the given version is older than the current JSPWiki version</a>
<span class="sourceLineNo">134</span><a id="line.134"> * @since 2.4.57</a>
<span class="sourceLineNo">135</span><a id="line.135"> * @throws IllegalArgumentException If the version string could not be parsed.</a>
<span class="sourceLineNo">136</span><a id="line.136"> */</a>
<span class="sourceLineNo">137</span><a id="line.137"> public static boolean isOlderOrEqual( final String version ) throws IllegalArgumentException {</a>
<span class="sourceLineNo">138</span><a id="line.138"> if( version == null ) {</a>
<span class="sourceLineNo">139</span><a id="line.139"> return true;</a>
<span class="sourceLineNo">140</span><a id="line.140"> }</a>
<span class="sourceLineNo">141</span><a id="line.141"></a>
<span class="sourceLineNo">142</span><a id="line.142"> final String[] versionComponents = StringUtils.split( version, VERSION_SEPARATORS );</a>
<span class="sourceLineNo">143</span><a id="line.143"> final int versionCompoLength = versionComponents.length;</a>
<span class="sourceLineNo">144</span><a id="line.144"> final int reqVersion = versionCompoLength &gt; 0 ? Integer.parseInt( versionComponents[0] ) : Release.VERSION;</a>
<span class="sourceLineNo">145</span><a id="line.145"> final int reqRevision = versionCompoLength &gt; 1 ? Integer.parseInt( versionComponents[1] ) : Release.REVISION;</a>
<span class="sourceLineNo">146</span><a id="line.146"> final int reqMinorRevision = versionCompoLength &gt; 2 ? Integer.parseInt( versionComponents[2] ) : Release.MINORREVISION;</a>
<span class="sourceLineNo">147</span><a id="line.147"></a>
<span class="sourceLineNo">148</span><a id="line.148"> if( VERSION == reqVersion ) {</a>
<span class="sourceLineNo">149</span><a id="line.149"> if( REVISION == reqRevision ) {</a>
<span class="sourceLineNo">150</span><a id="line.150"> if( MINORREVISION == reqMinorRevision ) {</a>
<span class="sourceLineNo">151</span><a id="line.151"> return true;</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"> return MINORREVISION &lt; reqMinorRevision;</a>
<span class="sourceLineNo">154</span><a id="line.154"> }</a>
<span class="sourceLineNo">155</span><a id="line.155"> return REVISION &lt; reqRevision;</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157"> return VERSION &lt; reqVersion;</a>
<span class="sourceLineNo">158</span><a id="line.158"> }</a>
<span class="sourceLineNo">159</span><a id="line.159"></a>
<span class="sourceLineNo">160</span><a id="line.160"> /**</a>
<span class="sourceLineNo">161</span><a id="line.161"> * Executing this class directly from command line prints out the current version. It is very useful for</a>
<span class="sourceLineNo">162</span><a id="line.162"> * things like different command line tools.</a>
<span class="sourceLineNo">163</span><a id="line.163"> * &lt;P&gt;Example:</a>
<span class="sourceLineNo">164</span><a id="line.164"> * &lt;PRE&gt;</a>
<span class="sourceLineNo">165</span><a id="line.165"> * % java org.apache.wiki.api.Release</a>
<span class="sourceLineNo">166</span><a id="line.166"> * 1.9.26-cvs</a>
<span class="sourceLineNo">167</span><a id="line.167"> * &lt;/PRE&gt;</a>
<span class="sourceLineNo">168</span><a id="line.168"> *</a>
<span class="sourceLineNo">169</span><a id="line.169"> * @param argv The argument string. This class takes in no arguments.</a>
<span class="sourceLineNo">170</span><a id="line.170"> */</a>
<span class="sourceLineNo">171</span><a id="line.171"> public static void main( final String[] argv ) {</a>
<span class="sourceLineNo">172</span><a id="line.172"> System.out.println( VERSTR );</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175">}</a>
</pre>
</div>
</main>
</body>
</html>