/* ----------------------------------------------------------------------------
 * 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.*;
/**
 * Maps from int return codes to defined Error values.<br>
 * <p><br>
 * This class is used to map from AVPKit return codes<br>
 * (for example on {IContainer#readNextPacket(IPacket)}<br>
 * into an enum type if the error is known and a text description.<br>
 * </p><p><br>
 * WARNING: Do not write code that depends on the integer values<br>
 * returned from AVPKit; instead use the integer value to create<br>
 * one of these objects.  That's because integer values returned<br>
 * from methods can have different meanings on different OS systems<br>
 * (for example, ERROR_AGAIN is -11 on Linux, but a different<br>
 * value on MacOS).  This class maps the error to a os-type-safe<br>
 * value.<br>
 * </p><p><br>
 * Also, do not depend on the string messages staying constant.  They<br>
 * are for debugging purposes only.  And we can't control whether or<br>
 * not they are localized -- that's up to your OS.  Sorry.<br>
 * </p>
 */
public class IError 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 IError(long cPtr, boolean cMemoryOwn) {
    super(AVPKitJNI.IError_SWIGUpcast(cPtr), cMemoryOwn);
    swigCPtr = cPtr;
  }
  
  /**
   * Internal Only.
   */
  protected IError(long cPtr, boolean cMemoryOwn,
      java.util.concurrent.atomic.AtomicLong ref)
  {
    super(AVPKitJNI.IError_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(IError 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 IError object that is actually referring to the
   * exact same underlying native object.
   *
   * @return the new Java object.
   */
  @Override
  public IError copyReference() {
    if (swigCPtr == 0)
      return null;
    else
      return new IError(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 IError)
      equal = (((IError)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
  

  /**
   * Return a string representation of this error
   * 
   * @return the error as a string
   */
  public String toString()
  {
    return getDescription();
  }

  /**
   * Get the OS-independent AVPKit type for this error.<br>
   * <br>
   * @return the type.
   */
  public IError.Type getType() {
    return IError.Type.swigToEnum(AVPKitJNI.IError_getType(swigCPtr, this));
  }

  /**
   * Get a text description for this error.<br>
   * <br>
   * The description returned will be in whatever language<br>
   * the underlying OS decides to use, and no, we can't<br>
   * support localization here if the OS hasn't already done it.<br>
   * <br>
   * Sorry.<br>
   * <br>
   * @return the description.
   */
  public String getDescription() {
    return AVPKitJNI.IError_getDescription(swigCPtr, this);
  }

  /**
   * Return the raw integer value that AVPKit returned and<br>
   * was used to create this IError.<br>
   * <br>
   * Note that this value can have different meanings on<br>
   * different operating systems.  Use {#getType()}<br>
   * instead for programmatic decisions.<br>
   * <br>
   * @return the native error number.
   */
  public int getErrorNumber() {
    return AVPKitJNI.IError_getErrorNumber(swigCPtr, this);
  }

  /**
   * Create a new IError object from a return value passed in from AVPKit.<br>
   * <br>
   * @param errorNumber The error number as returned from another<br>
   *   AVPKit call.  ErrorNumber must be &lt; 0.<br>
   * @return a new IError, or null on error.
   */
  public static IError make(int errorNumber) {
    long cPtr = AVPKitJNI.IError_make__SWIG_0(errorNumber);
    return (cPtr == 0) ? null : new IError(cPtr, false);
  }

  /**
   * Create a new IError object from an IError.Type enum value.<br>
   * <br>
   * @param type The type to use for creation.<br>
   * @return a new IError, or null on error.
   */
  public static IError make(IError.Type type) {
    long cPtr = AVPKitJNI.IError_make__SWIG_1(type.swigValue());
    return (cPtr == 0) ? null : new IError(cPtr, false);
  }

  /**
   * Translate an error number to a type.<br>
   * @param errorNo The error returned from AVPKit<br>
   * @return the type
   */
  public static IError.Type errorNumberToType(int errorNo) {
    return IError.Type.swigToEnum(AVPKitJNI.IError_errorNumberToType(errorNo));
  }

  /**
   * Translate an a type to an error number.<br>
   * @param type The type<br>
   * @return the error number
   */
  public static int typeToErrorNumber(IError.Type type) {
    return AVPKitJNI.IError_typeToErrorNumber(type.swigValue());
  }

  /**
   * A set of errors that AVPKit knows about.
   */
  public enum Type {
    ERROR_UNKNOWN,
    ERROR_IO,
    ERROR_NUMEXPECTED,
    ERROR_INVALIDDATA,
    ERROR_NOMEM,
    ERROR_NOFMT,
    ERROR_NOTSUPPORTED,
    ERROR_NOENT,
    ERROR_EOF,
    ERROR_RANGE,
    ERROR_AGAIN,
    ERROR_PATCHWELCOME,
    ERROR_INTERRUPTED;

    public final int swigValue() {
      return swigValue;
    }

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

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

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

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

    private final int swigValue;

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

}