1 /*
2 * $Id: RandomGenerator.java,v 1.2 2005/10/08 16:22:22 weiju Exp $
3 *
4 * Created on 2005/09/23
5 * Copyright 2005 by Wei-ju Wu
6 *
7 * This file is part of The Z-machine Preservation Project (ZMPP).
8 *
9 * ZMPP is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * ZMPP is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ZMPP; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23 package org.zmpp.vmutil;
24
25 /***
26 * This interface defines the functions of a random number generator within
27 * the Z machine.
28 *
29 * @author Wei-ju Wu
30 * @version 1.0
31 */
32 public interface RandomGenerator {
33
34 /***
35 * The maximum generated value.
36 */
37 static final int MAX_VALUE = 32767;
38
39 /***
40 * Returns the next random value between 1 and MAX_VALUE.
41 *
42 * @return a random int value
43 */
44 int next();
45 }