com.datastax.astra.client.model.UUIDv7 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of astra-db-java Show documentation

Implementation of a client to the Astra/Stargate Data API written in Java

There is a newer version: 1.5.3

package com.datastax.astra.client.model;

/*-
 * #%L
 * Data API Java Client
 * --
 * Copyright (C) 2024 DataStax
 * --
 * Licensed under the Apache License, Version 2.0
 * 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.
 * #L%
 */

import com.fasterxml.uuid.Generators;

import java.security.SecureRandom;
import java.util.UUID;

/**
 * Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.
 */
public class UUIDv7 {

    /**
     * intenal uuid,.
     */
    private final UUID uuid;

    /**
     * Default constructor.
     */
    public UUIDv7() {
        this(Generators.timeBasedEpochRandomGenerator(new SecureRandom()).generate());
    }

    /**
     * Constructor.
     *
     * @param uuid
     *      unique identifier
     */
    public UUIDv7(UUID uuid) {
        this.uuid = uuid;
    }

    /**
     * Return the Java Utils UUID.
     *
     * @return
     *      uuid value
     */
    public UUID toUUID() {
        return uuid;
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        return toUUID().toString();
    }

    /**
     * Generate from a string.
     *
     * @param strUUID
     *      uuid as a String
     * @return
     *      an instance of UUIDv6
     */
    public static UUIDv7 fromString(String strUUID) {
        return new UUIDv7(UUID.fromString(strUUID));
    }

}