/*
 * Copyright (c) 2008-2014 MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bson.codecs;

/**
 * Classes that implement this interface define a way to create IDs for MongoDB documents.
 *
 * @since 3.0
 */
public interface IdGenerator {
    /**
     * Generates an ID for a MongoDB Document.
     *
     * @return any type of Object representing an ID.
     */
    Object generate();
}