Modified: websites/production/commons/content/proper/commons-lang/xref/org/apache/commons/lang3/RandomStringUtils.html ============================================================================== --- websites/production/commons/content/proper/commons-lang/xref/org/apache/commons/lang3/RandomStringUtils.html (original) +++ websites/production/commons/content/proper/commons-lang/xref/org/apache/commons/lang3/RandomStringUtils.html Thu Aug 29 19:59:17 2024 @@ -33,778 +33,778 @@ <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Generates random {@link String}s.</em> <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * Starting in version 3.16.0, this class uses {@link #secure()} for static methods and adds {@link #insecure()}.</em> -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Starting in version 3.15.0, this class uses {@link SecureRandom#getInstanceStrong()} for static methods.</em> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * Before version 3.15.0, this class used {@link ThreadLocalRandom#current()} for static methods, which is not</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * cryptographically secure.</em> -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an</em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()}; <b>which is not</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * cryptographically secure</b>.</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * RandomStringUtils is intended for simple use cases. For more advanced use cases consider using Apache Commons Text's</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <a href=</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * "<a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/RandomStringGenerator.html" target="alexandria_uri">https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/RandomStringGenerator.html</a>"></em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * RandomStringGenerator</a> instead.</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * The Apache Commons project provides <a href="<a href="https://commons.apache.org/proper/commons-rng/" target="alexandria_uri">https://commons.apache.org/proper/commons-rng/</a>">Commons RNG</a></em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * dedicated to pseudo-random number generation, that may be a better choice for applications with more stringent</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * requirements (performance and/or correctness).</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * Note that <em>private high surrogate</em> characters are ignored. These are Unicode characters that fall between the</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * values 56192 (db80) and 56319 (dbff) as we don't know how to handle them. High and low surrogates are correctly dealt</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * with - that is if a high surrogate is randomly chosen, 55296 (d800) to 56191 (db7f) then it is followed by a low</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * surrogate. If a low surrogate is chosen, 56320 (dc00) to 57343 (dfff) then it is placed after a randomly chosen high</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * surrogate.</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * #ThreadSafe#</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @see RandomUtils</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @since 1.0</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> { -<a class="jxr_linenumber" name="L71" href="#L71">71</a> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Supplier<RandomUtils> SECURE_SUPPLIER = RandomUtils::secure; -<a class="jxr_linenumber" name="L73" href="#L73">73</a> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> INSECURE = <strong class="jxr_keyword">new</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a>(RandomUtils::insecure); -<a class="jxr_linenumber" name="L75" href="#L75">75</a> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> SECURE = <strong class="jxr_keyword">new</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a>(SECURE_SUPPLIER); -<a class="jxr_linenumber" name="L77" href="#L77">77</a> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] ALPHANUMERICAL_CHARS = { 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', -<a class="jxr_linenumber" name="L79" href="#L79">79</a> 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', -<a class="jxr_linenumber" name="L80" href="#L80">80</a> 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '0', '1', -<a class="jxr_linenumber" name="L81" href="#L81">81</a> '2', '3', '4', '5', '6', '7', '8', '9' }; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator implementing the</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * default random number algorithm.</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an instance that was selected by using</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property.</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} <b>which is not cryptographically secure</b>. In addition,</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * {@code true}.</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Starting in version 3.17.0, the method {@link #secure()} uses {@link SecureRandom#SecureRandom()} instead of {@link SecureRandom#getInstanceStrong()}, and</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * adds {@link #secureStrong()}.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * Starting in version 3.16.0, this class uses {@link #secure()} for static methods and adds {@link #insecure()}.</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Starting in version 3.15.0, this class uses {@link SecureRandom#getInstanceStrong()} for static methods.</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Before version 3.15.0, this class used {@link ThreadLocalRandom#current()} for static methods, which is not cryptographically secure.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * RandomStringUtils is intended for simple use cases. For more advanced use cases consider using Apache Commons Text's</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * <a href= "<a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/RandomStringGenerator.html" target="alexandria_uri">https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/RandomStringGenerator.html</a>"> RandomStringGenerator</a></em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * instead.</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * The Apache Commons project provides <a href="<a href="https://commons.apache.org/proper/commons-rng/" target="alexandria_uri">https://commons.apache.org/proper/commons-rng/</a>">Commons RNG</a> dedicated to pseudo-random number generation,</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * that may be a better choice for applications with more stringent requirements (performance and/or correctness).</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Note that <em>private high surrogate</em> characters are ignored. These are Unicode characters that fall between the values 56192 (db80) and 56319 (dbff) as</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * we don't know how to handle them. High and low surrogates are correctly dealt with - that is if a high surrogate is randomly chosen, 55296 (d800) to 56191</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * (db7f) then it is followed by a low surrogate. If a low surrogate is chosen, 56320 (dc00) to 57343 (dfff) then it is placed after a randomly chosen high</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * surrogate.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * #ThreadSafe#</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @see #secure()</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @see #secureStrong()</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @see #insecure()</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @see SecureRandom#SecureRandom()</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @see SecureRandom#getInstanceStrong()</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @see ThreadLocalRandom#current()</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @see RandomUtils</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 1.0</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> { <a class="jxr_linenumber" name="L82" href="#L82">82</a> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Gets the singleton instance based on {@link ThreadLocalRandom#current()}; <b>which is not cryptographically</em> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * secure</b>; use {@link #secure()} to use an algorithms/providers specified in the</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * {@code securerandom.strongAlgorithms} {@link Security} property.</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * The method {@link ThreadLocalRandom#current()} is called on-demand.</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @return the singleton instance based on {@link ThreadLocalRandom#current()}.</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @see ThreadLocalRandom#current()</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @see #secure()</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @since 3.16.0</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> insecure() { -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> INSECURE; -<a class="jxr_linenumber" name="L98" href="#L98">98</a> } -<a class="jxr_linenumber" name="L99" href="#L99">99</a> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of all characters.</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count) { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> secure().next(count); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> } -<a class="jxr_linenumber" name="L114" href="#L114">114</a> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers) { -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> secure().next(count, letters, numbers); -<a class="jxr_linenumber" name="L130" href="#L130">130</a> } -<a class="jxr_linenumber" name="L131" href="#L131">131</a> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of characters specified.</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @param chars the character array containing the set of characters to use, may be null</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Supplier<RandomUtils> SECURE_SUPPLIER = RandomUtils::secure; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> INSECURE = <strong class="jxr_keyword">new</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a>(RandomUtils::insecure); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> SECURE = <strong class="jxr_keyword">new</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a>(SECURE_SUPPLIER); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> SECURE_STRONG = <strong class="jxr_keyword">new</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a>(RandomUtils::secureStrong); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] ALPHANUMERICAL_CHARS = { 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', +<a class="jxr_linenumber" name="L92" href="#L92">92</a> 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F', 'G', +<a class="jxr_linenumber" name="L93" href="#L93">93</a> 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '0', '1', +<a class="jxr_linenumber" name="L94" href="#L94">94</a> '2', '3', '4', '5', '6', '7', '8', '9' }; +<a class="jxr_linenumber" name="L95" href="#L95">95</a> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Gets the singleton instance based on {@link ThreadLocalRandom#current()}; <b>which is not cryptographically</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * secure</b>; use {@link #secure()} to use an algorithms/providers specified in the</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * {@code securerandom.strongAlgorithms} {@link Security} property.</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * The method {@link ThreadLocalRandom#current()} is called on-demand.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return the singleton instance based on {@link ThreadLocalRandom#current()}.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @see ThreadLocalRandom#current()</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @see #secure()</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @since 3.16.0</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="RandomStringUtils" href="../../../../org/apache/commons/lang3/RandomStringUtils.html#RandomStringUtils">RandomStringUtils</a> insecure() { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> INSECURE; +<a class="jxr_linenumber" name="L111" href="#L111">111</a> } +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of all characters.</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #secure()}, {@link #secureStrong()},or {@link #insecure()}.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Deprecated +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> secure().next(count); +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #secure()}, {@link #secureStrong()},or {@link #insecure()}.</em> <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>... chars) { -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> secure().next(count, chars); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> } -<a class="jxr_linenumber" name="L147" href="#L147">147</a> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers) { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">return</strong> secure().next(count, start, end, letters, numbers); -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * Creates a random string based on a variety of options, using default source of randomness.</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * This method has exactly the same semantics as {@link #random(int,int,int,boolean,boolean,char[],Random)}, but</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * instead of using an externally supplied source of randomness, it uses the internal static {@link Random}</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * instance.</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @param chars the set of chars to choose randoms from. If {@code null}, then it will use the set of all chars.</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.</em> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>... chars) { -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">return</strong> secure().next(count, start, end, letters, numbers, chars); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> } -<a class="jxr_linenumber" name="L191" href="#L191">191</a> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * Creates a random string based on a variety of options, using supplied source of randomness.</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * If start and end are both {@code 0}, start and end are set to {@code ' '} and {@code 'z'}, the ASCII printable</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * characters, will be used, unless letters and numbers are both {@code false}, in which case, start and end are set</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * to {@code 0} and {@link Character#MAX_CODE_POINT}.</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * If set is not {@code null}, characters between start and end are chosen.</em> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * This method accepts a user-supplied {@link Random} instance to use as a source of randomness. By seeding a single</em> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * {@link Random} instance with a fixed seed and using it for each call, the same random sequence of strings can be</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * generated repeatedly and predictably.</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at (inclusive)</em> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before (exclusive)</em> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @param chars the set of chars to choose randoms from, must not be empty. If {@code null}, then it will use the</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * set of all chars.</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @param random a source of randomness.</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @return the random string</em> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.</em> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0 or the provided chars array is empty.</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers, -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] chars, <strong class="jxr_keyword">final</strong> Random random) { -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">if</strong> (count == 0) { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">return</strong> StringUtils.EMPTY; -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (count < 0) { -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Requested random string length "</span> + count + <span class="jxr_string">" is less than 0."</span>); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> } -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">if</strong> (chars != <strong class="jxr_keyword">null</strong> && chars.length == 0) { -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The chars array must not be empty"</span>); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> } -<a class="jxr_linenumber" name="L234" href="#L234">234</a> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> (start == 0 && end == 0) { -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">if</strong> (chars != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L237" href="#L237">237</a> end = chars.length; -<a class="jxr_linenumber" name="L238" href="#L238">238</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!letters && !numbers) { -<a class="jxr_linenumber" name="L239" href="#L239">239</a> end = Character.MAX_CODE_POINT; -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L241" href="#L241">241</a> end = 'z' + 1; -<a class="jxr_linenumber" name="L242" href="#L242">242</a> start = ' '; -<a class="jxr_linenumber" name="L243" href="#L243">243</a> } -<a class="jxr_linenumber" name="L244" href="#L244">244</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (end <= start) { -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException( -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <span class="jxr_string">"Parameter end ("</span> + end + <span class="jxr_string">") must be greater than start ("</span> + start + <span class="jxr_string">")"</span>); -<a class="jxr_linenumber" name="L247" href="#L247">247</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (start < 0 || end < 0) { -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Character positions MUST be >= 0"</span>); -<a class="jxr_linenumber" name="L249" href="#L249">249</a> } -<a class="jxr_linenumber" name="L250" href="#L250">250</a> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> (end > Character.MAX_CODE_POINT) { -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_comment">// Technically, it should be `Character.MAX_CODE_POINT+1` as `end` is excluded</em> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_comment">// But the character `Character.MAX_CODE_POINT` is private use, so it would anyway be excluded</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> end = Character.MAX_CODE_POINT; -<a class="jxr_linenumber" name="L255" href="#L255">255</a> } -<a class="jxr_linenumber" name="L256" href="#L256">256</a> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_comment">// Optimize generation of full alphanumerical characters</em> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_comment">// Normally, we would need to pick a 7-bit integer, since gap = 'z' - '0' + 1 = 75 > 64</em> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">// In turn, this would make us reject the sampling with probability 1 - 62 / 2^7 > 1 / 2</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_comment">// Instead we can pick directly from the right set of 62 characters, which requires</em> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_comment">// picking a 6-bit integer and only rejecting with probability 2 / 64 = 1 / 32</em> -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong> && letters && numbers && start <= '0' && end >= 'z' + 1) { -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> random(count, 0, 0, false, false, ALPHANUMERICAL_CHARS, random); -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } -<a class="jxr_linenumber" name="L265" href="#L265">265</a> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_comment">// Optimize start and end when filtering by letters and/or numbers:</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_comment">// The range provided may be too large since we filter anyway afterward.</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_comment">// Note the use of Math.min/max (as opposed to setting start to '0' for example),</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_comment">// since it is possible the range start/end excludes some of the letters/numbers,</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_comment">// e.g., it is possible that start already is '1' when numbers = true, and start</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_comment">// needs to stay equal to '1' in that case.</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (letters && numbers) { -<a class="jxr_linenumber" name="L274" href="#L274">274</a> start = Math.max('0', start); -<a class="jxr_linenumber" name="L275" href="#L275">275</a> end = Math.min('z' + 1, end); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (numbers) { -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_comment">// just numbers, no letters</em> -<a class="jxr_linenumber" name="L278" href="#L278">278</a> start = Math.max('0', start); -<a class="jxr_linenumber" name="L279" href="#L279">279</a> end = Math.min('9' + 1, end); -<a class="jxr_linenumber" name="L280" href="#L280">280</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (letters) { -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// just letters, no numbers</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> start = Math.max('A', start); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> end = Math.min('z' + 1, end); -<a class="jxr_linenumber" name="L284" href="#L284">284</a> } -<a class="jxr_linenumber" name="L285" href="#L285">285</a> } -<a class="jxr_linenumber" name="L286" href="#L286">286</a> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> zeroDigitAscii = 48; -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> firstLetterAscii = 65; -<a class="jxr_linenumber" name="L289" href="#L289">289</a> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong> && (numbers && end <= zeroDigitAscii || letters && end <= firstLetterAscii)) { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException( -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <span class="jxr_string">"Parameter end ("</span> + end + <span class="jxr_string">") must be greater then ("</span> + zeroDigitAscii + <span class="jxr_string">") for generating digits "</span> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> + <span class="jxr_string">"or greater then ("</span> + firstLetterAscii + <span class="jxr_string">") for generating letters."</span>); -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">final</strong> StringBuilder builder = <strong class="jxr_keyword">new</strong> StringBuilder(count); -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> gap = end - start; -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> gapBits = Integer.SIZE - Integer.numberOfLeadingZeros(gap); -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_comment">// The size of the cache we use is an heuristic:</em> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_comment">// about twice the number of bytes required if no rejection</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_comment">// Ideally the cache size depends on multiple factor, including the cost of generating x bytes</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_comment">// of randomness as well as the probability of rejection. It is however not easy to know</em> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_comment">// those values programmatically for the general case.</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">final</strong> <a name="CachedRandomBits" href="../../../../org/apache/commons/lang3/CachedRandomBits.html#CachedRandomBits">CachedRandomBits</a> arb = <strong class="jxr_keyword">new</strong> <a name="CachedRandomBits" href="../../../../org/apache/commons/lang3/CachedRandomBits.html#CachedRandomBits">CachedRandomBits</a>((count * gapBits + 3) / 5 + 10, random); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">while</strong> (count-- != 0) { -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_comment">// Generate a random value between start (included) and end (excluded)</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> randomValue = arb.nextBits(gapBits) + start; -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_comment">// Rejection sampling if value too large</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">if</strong> (randomValue >= end) { -<a class="jxr_linenumber" name="L311" href="#L311">311</a> count++; -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">continue</strong>; -<a class="jxr_linenumber" name="L313" href="#L313">313</a> } -<a class="jxr_linenumber" name="L314" href="#L314">314</a> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> codePoint; -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L317" href="#L317">317</a> codePoint = randomValue; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Deprecated +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers) { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> secure().next(count, letters, numbers); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of characters specified.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * @param chars the character array containing the set of characters to use, may be null</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #secure()}, {@link #secureStrong()},or {@link #insecure()}.</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> @Deprecated +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>... chars) { +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">return</strong> secure().next(count, chars); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +<a class="jxr_linenumber" name="L166" href="#L166">166</a> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * Creates a random string whose length is the number of characters specified.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Characters will be chosen from the set of alpha-numeric characters as indicated by the arguments.</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #secure()}, {@link #secureStrong()},or {@link #insecure()}.</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> @Deprecated +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers) { +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> secure().next(count, start, end, letters, numbers); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> } +<a class="jxr_linenumber" name="L188" href="#L188">188</a> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * Creates a random string based on a variety of options, using default source of randomness.</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * This method has exactly the same semantics as {@link #random(int,int,int,boolean,boolean,char[],Random)}, but</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * instead of using an externally supplied source of randomness, it uses the internal static {@link Random}</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * instance.</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @param chars the set of chars to choose randoms from. If {@code null}, then it will use the set of all chars.</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0.</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #secure()}, {@link #secureStrong()},or {@link #insecure()}.</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> @Deprecated +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>... chars) { +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> secure().next(count, start, end, letters, numbers, chars); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> } +<a class="jxr_linenumber" name="L214" href="#L214">214</a> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * Creates a random string based on a variety of options, using supplied source of randomness.</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * If start and end are both {@code 0}, start and end are set to {@code ' '} and {@code 'z'}, the ASCII printable</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * characters, will be used, unless letters and numbers are both {@code false}, in which case, start and end are set</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * to {@code 0} and {@link Character#MAX_CODE_POINT}.</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * If set is not {@code null}, characters between start and end are chosen.</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * This method accepts a user-supplied {@link Random} instance to use as a source of randomness. By seeding a single</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * {@link Random} instance with a fixed seed and using it for each call, the same random sequence of strings can be</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * generated repeatedly and predictably.</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param count the length of random string to create</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param start the position in set of chars to start at (inclusive)</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param end the position in set of chars to end before (exclusive)</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @param letters if {@code true}, generated string may include alphabetic characters</em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @param numbers if {@code true}, generated string may include numeric characters</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param chars the set of chars to choose randoms from, must not be empty. If {@code null}, then it will use the</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * set of all chars.</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @param random a source of randomness.</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @return the random string</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code count} &lt; 0 or the provided chars array is empty.</em> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String random(<strong class="jxr_keyword">int</strong> count, <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">int</strong> end, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> letters, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> numbers, +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] chars, <strong class="jxr_keyword">final</strong> Random random) { +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">if</strong> (count == 0) { +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">return</strong> StringUtils.EMPTY; +<a class="jxr_linenumber" name="L250" href="#L250">250</a> } +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> (count < 0) { +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Requested random string length "</span> + count + <span class="jxr_string">" is less than 0."</span>); +<a class="jxr_linenumber" name="L253" href="#L253">253</a> } +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> (chars != <strong class="jxr_keyword">null</strong> && chars.length == 0) { +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"The chars array must not be empty"</span>); +<a class="jxr_linenumber" name="L256" href="#L256">256</a> } +<a class="jxr_linenumber" name="L257" href="#L257">257</a> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (start == 0 && end == 0) { +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">if</strong> (chars != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L260" href="#L260">260</a> end = chars.length; +<a class="jxr_linenumber" name="L261" href="#L261">261</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!letters && !numbers) { +<a class="jxr_linenumber" name="L262" href="#L262">262</a> end = Character.MAX_CODE_POINT; +<a class="jxr_linenumber" name="L263" href="#L263">263</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L264" href="#L264">264</a> end = 'z' + 1; +<a class="jxr_linenumber" name="L265" href="#L265">265</a> start = ' '; +<a class="jxr_linenumber" name="L266" href="#L266">266</a> } +<a class="jxr_linenumber" name="L267" href="#L267">267</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (end <= start) { +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException( +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <span class="jxr_string">"Parameter end ("</span> + end + <span class="jxr_string">") must be greater than start ("</span> + start + <span class="jxr_string">")"</span>); +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (start < 0 || end < 0) { +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Character positions MUST be >= 0"</span>); +<a class="jxr_linenumber" name="L272" href="#L272">272</a> } +<a class="jxr_linenumber" name="L273" href="#L273">273</a> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">if</strong> (end > Character.MAX_CODE_POINT) { +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_comment">// Technically, it should be `Character.MAX_CODE_POINT+1` as `end` is excluded</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">// But the character `Character.MAX_CODE_POINT` is private use, so it would anyway be excluded</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> end = Character.MAX_CODE_POINT; +<a class="jxr_linenumber" name="L278" href="#L278">278</a> } +<a class="jxr_linenumber" name="L279" href="#L279">279</a> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_comment">// Optimize generation of full alphanumerical characters</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// Normally, we would need to pick a 7-bit integer, since gap = 'z' - '0' + 1 = 75 > 64</em> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_comment">// In turn, this would make us reject the sampling with probability 1 - 62 / 2^7 > 1 / 2</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_comment">// Instead we can pick directly from the right set of 62 characters, which requires</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_comment">// picking a 6-bit integer and only rejecting with probability 2 / 64 = 1 / 32</em> +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong> && letters && numbers && start <= '0' && end >= 'z' + 1) { +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">return</strong> random(count, 0, 0, false, false, ALPHANUMERICAL_CHARS, random); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> } +<a class="jxr_linenumber" name="L288" href="#L288">288</a> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_comment">// Optimize start and end when filtering by letters and/or numbers:</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_comment">// The range provided may be too large since we filter anyway afterward.</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_comment">// Note the use of Math.min/max (as opposed to setting start to '0' for example),</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_comment">// since it is possible the range start/end excludes some of the letters/numbers,</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_comment">// e.g., it is possible that start already is '1' when numbers = true, and start</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_comment">// needs to stay equal to '1' in that case.</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">if</strong> (letters && numbers) { +<a class="jxr_linenumber" name="L297" href="#L297">297</a> start = Math.max('0', start); +<a class="jxr_linenumber" name="L298" href="#L298">298</a> end = Math.min('z' + 1, end); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (numbers) { +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_comment">// just numbers, no letters</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> start = Math.max('0', start); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> end = Math.min('9' + 1, end); +<a class="jxr_linenumber" name="L303" href="#L303">303</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (letters) { +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_comment">// just letters, no numbers</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> start = Math.max('A', start); +<a class="jxr_linenumber" name="L306" href="#L306">306</a> end = Math.min('z' + 1, end); +<a class="jxr_linenumber" name="L307" href="#L307">307</a> } +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> zeroDigitAscii = 48; +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> firstLetterAscii = 65; +<a class="jxr_linenumber" name="L312" href="#L312">312</a> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">if</strong> (chars == <strong class="jxr_keyword">null</strong> && (numbers && end <= zeroDigitAscii || letters && end <= firstLetterAscii)) { +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException( +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <span class="jxr_string">"Parameter end ("</span> + end + <span class="jxr_string">") must be greater then ("</span> + zeroDigitAscii + <span class="jxr_string">") for generating digits "</span> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> + <span class="jxr_string">"or greater then ("</span> + firstLetterAscii + <span class="jxr_string">") for generating letters."</span>); +<a class="jxr_linenumber" name="L317" href="#L317">317</a> } <a class="jxr_linenumber" name="L318" href="#L318">318</a> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">switch</strong> (Character.getType(codePoint)) { -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">case</strong> Character.UNASSIGNED:
[... 1240 lines stripped ...]