commons-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chtom...@apache.org
Subject svn commit: r1012767 [12/39] - in /websites/production/commons/content/proper/commons-text: ./ apidocs/ apidocs/org/apache/commons/text/ apidocs/org/apache/commons/text/class-use/ apidocs/org/apache/commons/text/diff/ apidocs/org/apache/commons/text/di...
Date Tue, 23 May 2017 13:12:45 GMT
Added: websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/TextRandomProvider.html
==============================================================================
--- websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/TextRandomProvider.html
(added)
+++ websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/TextRandomProvider.html
Tue May 23 13:12:41 2017
@@ -0,0 +1,123 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation
(ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements.  See
the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information
regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You under
the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this
file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of
the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a
name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is distributed
on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific language
governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.text;<a name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * &lt;p&gt;<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * TextRandomProvider implementations are
used by {@link RandomStringGenerator}<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * as a source of randomness.  It is highly
recommended that the<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * &lt;a href="http://commons.apache.org/proper/commons-rng/"&gt;Apache
Commons RNG&lt;/a&gt;<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * library be used to provide the random
number generation.<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * &lt;/p&gt;<a name="line.25"></a>
+<span class="sourceLineNo">026</span> *<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * &lt;p&gt;<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * When using Java 8 or later, TextRandomProvider
is a functional interface and<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * need not be explicitly implemented. 
For example:<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * &lt;/p&gt;<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * &lt;pre&gt;<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * {@code<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * UniformRandomProvider rng = RandomSource.create(...);<a
name="line.33"></a>
+<span class="sourceLineNo">034</span> * RandomStringGenerator gen = new RandomStringGenerator.Builder()<a
name="line.34"></a>
+<span class="sourceLineNo">035</span> *     .usingRandom(rng::nextInt)<a name="line.35"></a>
+<span class="sourceLineNo">036</span> *     // additional builder calls as needed<a
name="line.36"></a>
+<span class="sourceLineNo">037</span> *     .build();<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * }<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * &lt;/pre&gt;<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * @since 1.1<a name="line.40"></a>
+<span class="sourceLineNo">041</span> */<a name="line.41"></a>
+<span class="sourceLineNo">042</span>public interface TextRandomProvider {<a
name="line.42"></a>
+<span class="sourceLineNo">043</span><a name="line.43"></a>
+<span class="sourceLineNo">044</span>    /**<a name="line.44"></a>
+<span class="sourceLineNo">045</span>     * Generates an int value between 0
(inclusive) and the specified value<a name="line.45"></a>
+<span class="sourceLineNo">046</span>     * (exclusive).<a name="line.46"></a>
+<span class="sourceLineNo">047</span>     * @param max  Bound on the random number
to be returned. Must be positive.<a name="line.47"></a>
+<span class="sourceLineNo">048</span>     * @return a random int value between
0 (inclusive) and n (exclusive).<a name="line.48"></a>
+<span class="sourceLineNo">049</span>     */<a name="line.49"></a>
+<span class="sourceLineNo">050</span>    int nextInt(int max);<a name="line.50"></a>
+<span class="sourceLineNo">051</span>}<a name="line.51"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file



Mime
View raw message