gecko-dev/calendar/modules/util/inc/uidrgntr.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- 
 * 
 * The contents of this file are subject to the Netscape Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is Netscape 
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 */

/* 
 * uidrgntr.h
 * John Sun
 * 3/19/98 5:35:59 PM
 */

#ifndef __NSCALRANDOMGENERATOR_H_
#define __NSCALRANDOMGENERATOR_H_

#include <unistring.h>
#include "nscalutilexp.h"

/**
 *  Class that contains method to generate random UID strings.
 */
class NS_CAL_UTIL nsCalUIDRandomGenerator
{
public:
    /** default constructor.  It's of no use */
    nsCalUIDRandomGenerator();

    /** destructor.  It's of no use */
    ~nsCalUIDRandomGenerator();

    /**
     * generates random UID strings by appending 
     * current date time value is UTC ISO8601 format with
     * a random hexadecimal number.
     *
     * @return          new random UID string
     */
    static UnicodeString generate();

    /**
     * generates random UID strings by appending 
     * current date time value is UTC ISO8601 format with
     * a random hexadecimal number and input string.
     * Usually this input string would be a user@hostname or
     * e-mail address.
     *
     * @param           us  string to append to output
     *
     * @return          new random UID string
     */
    static UnicodeString generate(UnicodeString us);
};

#endif /*__NSCALRANDOMGENERATOR_H_ */