com.convergencelabs.convergence.server.util.QueryOffset.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2019 - Convergence Labs, Inc.
 *
 * This file is part of the Convergence Server, which is released under
 * the terms of the GNU General Public License version 3 (GPLv3). A copy
 * of the GPLv3 should have been provided along with this file, typically
 * located in the "LICENSE" file, which is part of this source code package.
 * Alternatively, see  for the
 * full text of the GPLv3 license, if it was not provided.
 */

package com.convergencelabs.convergence.server.util

import com.fasterxml.jackson.annotation.JsonIgnore

/**
 * A value class that wraps and optional integer representing an
 * offset into a set of ordered items such as a database query.
 *
 * @param value The offset, or None if no offset is set.
 */
final class QueryOffset( val value: Option[Long]) extends AnyVal {
  @JsonIgnore()
  def getOrZero: Long = value.getOrElse(0)

  @JsonIgnore()
  def getOrElse(v: Long): QueryOffset = QueryOffset(value.getOrElse(v))

  override def toString: String = s"{QueryOffset($value)}"
}

object QueryOffset {
  val Empty = new QueryOffset(None)

  def apply(): QueryOffset = Empty

  def apply(offset: Long): QueryOffset = new QueryOffset(Some(offset))

  def apply(offset: Option[Long]): QueryOffset = new QueryOffset(offset)
}