mongo4cats.bson.package.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Kirill5k
 *
 * 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 mongo4cats

import org.bson.types.{ObjectId => JObjectId}

import java.time.Instant
import java.util.Date

package object bson {

  type ObjectId = JObjectId
  object ObjectId {
    def apply(): ObjectId = new JObjectId()

    def gen: ObjectId = apply()

    def isValid(hex: String): Boolean = JObjectId.isValid(hex)

    /** Constructs a new instance from a 24-byte hexadecimal string representation.
      *
      * @param hex
      *   the string to convert
      * @throws IllegalArgumentException
      *   if the string is not a valid hex string representation of an ObjectId
      */
    def apply(hex: String): ObjectId = new JObjectId(hex)

    /** Constructs a new instance from a 24-byte hexadecimal string representation.
      *
      * @param hex
      *   the string to convert
      */
    def from(hex: String): Either[String, ObjectId] =
      Either.cond(isValid(hex), apply(hex), s"Invalid hexadecimal representation of an ObjectId $hex")

    /** Constructs a new instance from the given byte array
      *
      * @param bytes
      *   the byte array
      * @throws IllegalArgumentException
      *   if array is null or not of length 12
      */
    def apply(bytes: Array[Byte]): ObjectId = new JObjectId(bytes)

    /** Constructs a new instance using the given instant.
      *
      * @param instant
      *   the instant
      */
    def apply(instant: Instant) = new JObjectId(Date.from(instant))
  }
}