/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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
 *
 *    https://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.grails.datastore.mapping.mongo.connections

import groovy.transform.CompileStatic
import groovy.transform.builder.Builder
import groovy.transform.builder.SimpleStrategy

/**
 * Settings grouped under the {@code grails.mongodb.stringIds} namespace. The
 * {@code @Builder(SimpleStrategy)} annotation lets {@code ConfigurationBuilder}
 * recurse into this class so its fields bind at the nested property path.
 *
 * @since 7.1.1
 */
@Builder(builderStrategy = SimpleStrategy, prefix = '')
@CompileStatic
class StringIdSettings {

    /**
     * Global default storage type for {@code String id} fields that don't declare an
     * explicit {@code id storedAs: ...} in their mapping. Accepted values are
     * {@code 'string'} (default, current behavior) or {@code 'objectid'}.
     *
     * <p>Corresponds to the property path
     * {@code grails.mongodb.stringIds.defaultStoredAs}.
     */
    String defaultStoredAs

}
