/* ----------------------------------------------------------------------------
 * This file was automatically generated by SWIG (http://www.swig.org).
 * Version 4.0.2
 *
 * Do not make changes to this file unless you know what you are doing--modify
 * the SWIG interface file instead.
 * ----------------------------------------------------------------------------- */

package com.avpkit.core;
import com.avpkit.ferry.*;
/**
 * Time (duration) values with units.<br>
 * This class also has methods<br>
 * that correctly account for long wrapping when comparing time values.<br>
 * @deprecated .  Do not use.
 */
public class ITimeValue extends RefCounted {
  // JNIHelper.swg: Start generated code
  // >>>>>>>>>>>>>>>>>>>>>>>>>>>
  /**
   * This method is only here to use some references and remove
   * a Eclipse compiler warning.
   */
  @SuppressWarnings("unused")
  private void noop()
  {
    IBuffer.make(null, 1);
  }
   
  private volatile long swigCPtr;

  /**
   * Internal Only.
   */
  protected ITimeValue(long cPtr, boolean cMemoryOwn) {
    super(AVPKitJNI.ITimeValue_SWIGUpcast(cPtr), cMemoryOwn);
    swigCPtr = cPtr;
  }
  
  /**
   * Internal Only.
   */
  protected ITimeValue(long cPtr, boolean cMemoryOwn,
      java.util.concurrent.atomic.AtomicLong ref)
  {
    super(AVPKitJNI.ITimeValue_SWIGUpcast(cPtr),
     cMemoryOwn, ref);
    swigCPtr = cPtr;
  }
    
  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that obj is proxying for.
   *   
   * @param obj The java proxy object for a native object.
   * @return The raw pointer obj is proxying for.
   */
  public static long getCPtr(ITimeValue obj) {
    if (obj == null) return 0;
    return obj.getMyCPtr();
  }

  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that we're proxying for.
   *   
   * @return The raw pointer we're proxying for.
   */  
  public long getMyCPtr() {
    if (swigCPtr == 0) throw new IllegalStateException("underlying native object already deleted");
    return swigCPtr;
  }
  
  /**
   * Create a new ITimeValue object that is actually referring to the
   * exact same underlying native object.
   *
   * @return the new Java object.
   */
  @Override
  public ITimeValue copyReference() {
    if (swigCPtr == 0)
      return null;
    else
      return new ITimeValue(swigCPtr, swigCMemOwn, getJavaRefCount());
  }

  /**
   * Compares two values, returning true if the underlying objects in native code are the same object.
   *
   * That means you can have two different Java objects, but when you do a comparison, you'll find out
   * they are the EXACT same object.
   *
   * @return True if the underlying native object is the same.  False otherwise.
   */
  public boolean equals(Object obj) {
    boolean equal = false;
    if (obj instanceof ITimeValue)
      equal = (((ITimeValue)obj).swigCPtr == this.swigCPtr);
    return equal;
  }
  
  /**
   * Get a hashable value for this object.
   *
   * @return the hashable value.
   */
  public int hashCode() {
     return (int)swigCPtr;
  }
  
  // <<<<<<<<<<<<<<<<<<<<<<<<<<<
  // JNIHelper.swg: End generated code
  
  /**
   * Make a new time value.<br>
   * @param value The value.<br>
   * @param unit The unit value is expressed in.<br>
   * @return a new time value.
   */
  public static ITimeValue make(long value, ITimeValue.Unit unit) {
    long cPtr = AVPKitJNI.ITimeValue_make__SWIG_0(value, unit.swigValue());
    return (cPtr == 0) ? null : new ITimeValue(cPtr, false);
  }

  /**
   * Make a copy of a time value from another time value.<br>
   * @param src The time value to copy.  If 0 this method returns 0.<br>
   * @return a new time value.
   */
  public static ITimeValue make(ITimeValue src) {
    long cPtr = AVPKitJNI.ITimeValue_make__SWIG_1(ITimeValue.getCPtr(src), src);
    return (cPtr == 0) ? null : new ITimeValue(cPtr, false);
  }

  /**
   * Get the value of this ITimeValue, in the specified Unit.<br>
   * @param unit The unit you want to get a value as.<br>
   * @return The value, converted into the appropriate Unit.
   */
  public long get(ITimeValue.Unit unit) {
    return AVPKitJNI.ITimeValue_get(swigCPtr, this, unit.swigValue());
  }

  /**
   * Compare this timeValue to another.<br>
   * This compareTo will compare the values, but will assume that the values<br>
   * can never be more than half of int64_t's MAX_VALUE apart.  If they are<br>
   * it will assume long wrapping has occurred.  This is required especially<br>
   * if you're using TimeValue's as absolute time stamps, and want to know<br>
   * which is earlier.<br>
   * @param other the value to compare to<br>
   * @return -1 if this &lt; other; +1 if this &gt; other; 0 otherwise
   */
  public int compareTo(ITimeValue other) {
    return AVPKitJNI.ITimeValue_compareTo(swigCPtr, this, ITimeValue.getCPtr(other), other);
  }

  /**
   * Convenience method that calls a.compareTo(b).<br>
   * @see #compareTo<br>
   * @param a first value.<br>
   * @param b second value.<br>
   * @return -1 if a &lt; b; +1 if a &gt; b; 0 otherwise
   */
  public static int compare(ITimeValue a, ITimeValue b) {
    return AVPKitJNI.ITimeValue_compare__SWIG_0(ITimeValue.getCPtr(a), a, ITimeValue.getCPtr(b), b);
  }

  /**
   * And another convenience method that deals with un-unitted long values.<br>
   * @param a the first object.<br>
   * @param b the second object.<br>
   * @return #compare(ITimeValue, ITimeValue) where both a and b are assumed to be MICROSECONDS.
   */
  public static int compare(long a, long b) {
    return AVPKitJNI.ITimeValue_compare__SWIG_1(a, b);
  }

  public enum Unit {
    DAYS,
    HOURS,
    MINUTES,
    SECONDS,
    MILLISECONDS,
    MICROSECONDS,
    NANOSECONDS;

    public final int swigValue() {
      return swigValue;
    }

    public static Unit swigToEnum(int swigValue) {
      Unit[] swigValues = Unit.class.getEnumConstants();
      if (swigValue < swigValues.length && swigValue >= 0 && swigValues[swigValue].swigValue == swigValue)
        return swigValues[swigValue];
      for (Unit swigEnum : swigValues)
        if (swigEnum.swigValue == swigValue)
          return swigEnum;
      throw new IllegalArgumentException("No enum " + Unit.class + " with value " + swigValue);
    }

    @SuppressWarnings("unused")
    private Unit() {
      this.swigValue = SwigNext.next++;
    }

    @SuppressWarnings("unused")
    private Unit(int swigValue) {
      this.swigValue = swigValue;
      SwigNext.next = swigValue+1;
    }

    @SuppressWarnings("unused")
    private Unit(Unit swigEnum) {
      this.swigValue = swigEnum.swigValue;
      SwigNext.next = this.swigValue+1;
    }

    private final int swigValue;

    private static class SwigNext {
      private static int next = 0;
    }
  }

}