a997512994d42a64304501fe3724e11aca27c3d7
[jSite2.git] / src / net / pterodactylus / jsite / util / IdGenerator.java
1 /*
2  * jSite2 - IdGenerator.java -
3  * Copyright © 2008 David Roden
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 package net.pterodactylus.jsite.util;
21
22 import java.util.Random;
23
24 /**
25  * A generator for internal IDs.
26  * 
27  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
28  */
29 public class IdGenerator {
30
31         /** The default length of IDs (in bytes before conversion to a string). */
32         public static final int DEFAULT_LENGTH = 20;
33
34         /** The RNG used to created IDs. */
35         private static Random random = new Random();
36
37         /**
38          * Generates a new random ID, consisting of {@link #DEFAULT_LENGTH} random
39          * bytes.
40          * 
41          * @return The new ID
42          */
43         public static byte[] generateId() {
44                 return generateId(DEFAULT_LENGTH);
45         }
46
47         /**
48          * Generates a new random ID, consisting of <code>length</code> random
49          * bytes.
50          * 
51          * @param length
52          *            The length of the ID in bytes before conversion to a string
53          * @return The new ID
54          */
55         public static byte[] generateId(int length) {
56                 byte[] idBytes = new byte[length];
57                 random.nextBytes(idBytes);
58                 return idBytes;
59         }
60
61 }