org.bson.codecs.OverridableUuidRepresentationUuidCodec Maven / Gradle / Ivy

/*
 * Copyright 2008-present 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;

import org.bson.UuidRepresentation;

import java.util.UUID;

/**
 * An extension of {@code UuidCodec} that allows its configured {@code UuidRepresentation} to be overridden by an externally configured
 * {@code UuidRepresentation}, most likely configured on {@code MongoClientSettings} or {@code MongoClientOptions}.
 *
 * @since 3.12
 */
public class OverridableUuidRepresentationUuidCodec extends UuidCodec implements OverridableUuidRepresentationCodec {

    /**
     * Construct an instance with the default UUID representation.
     */
    public OverridableUuidRepresentationUuidCodec() {
    }

    /**
     * Construct an instance with the given UUID representation.
     *
     * @param uuidRepresentation the UUID representation
     */
    public OverridableUuidRepresentationUuidCodec(final UuidRepresentation uuidRepresentation) {
        super(uuidRepresentation);
    }

    @Override
    public Codec withUuidRepresentation(final UuidRepresentation uuidRepresentation) {
        return new OverridableUuidRepresentationUuidCodec(uuidRepresentation);
    }
}