KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > sync4j > framework > protocol > IdGenerator


1 /**
2  * Copyright (C) 2003-2005 Funambol
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18
19 package sync4j.framework.protocol;
20
21 /**
22  * This interface specifies an id generator. The <i>next()</i> method returns the
23  * newest generated id, whilst <i>current()</i> returns the latest generated id.
24  * <p>
25  *
26  * @author Stefano Fornari @ funambol
27  * @version $Id: IdGenerator.java,v 1.5 2005/03/02 20:57:38 harrie Exp $
28  */
29 public interface IdGenerator {
30
31   /**
32    * Returns a new generated id.
33    *
34    * @return a new generated id.
35    */
36   public String JavaDoc next();
37
38   /**
39    * Reset the generator to 0.
40    */
41   public void reset();
42
43   /**
44    * Returns the last generated id (which is the current id).
45    *
46    * @return the last generated id
47    */
48   public String JavaDoc current();
49 }
Popular Tags