Package jnr.ffi

Class NativeLong

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<NativeLong>
    public final class NativeLong
extends java.lang.Number
implements java.lang.Comparable<NativeLong>
    Represents a C long.

    In C, a long can be either 32 bits or 64bits, depending on the platform.

    Replace any function parameters which are long in the C definition with a NativeLong.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  NativeLong.Cache
      Internal cache of common native long values

    • Constructor Summary

      Constructors 
      Constructor Description
      NativeLong​(int value)
      Creates a new NativeLong instance with the supplied value.
      NativeLong​(long value)
      Creates a new NativeLong instance with the supplied value.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static NativeLong _valueOf​(int value)  
      private static NativeLong _valueOf​(long value)  
      int compareTo​(NativeLong other)
      Compares two NativeLong instances numerically.
      double doubleValue()
      Returns an double representation of this NativeLong.
      boolean equals​(java.lang.Object obj)
      Compares this NativeLong to another NativeLong.
      float floatValue()
      Returns an float representation of this NativeLong.
      int hashCode()
      Gets a hash code for this NativeLong.
      int intValue()
      Returns an integer representation of this NativeLong.
      long longValue()
      Returns an long representation of this NativeLong.
      java.lang.String toString()
      Returns a string representation of this NativeLong.
      static NativeLong valueOf​(int value)
      Returns a NativeLong instance representing the specified int value
      static NativeLong valueOf​(long value)
      Returns a NativeLong instance representing the specified long value

      • Methods inherited from class java.lang.Number

        byteValue, shortValue

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • MINUS_ONE

        private static final NativeLong MINUS_ONE

      • value

        private final long value

    • Constructor Detail

      • NativeLong

        public NativeLong​(long value)
        Creates a new NativeLong instance with the supplied value.
        Parameters:
        value - a long or integer.

      • NativeLong

        public NativeLong​(int value)
        Creates a new NativeLong instance with the supplied value.
        Parameters:
        value - an integer.

    • Method Detail

      • intValue

        public final int intValue()
        Returns an integer representation of this NativeLong.
        Specified by:
        intValue in class java.lang.Number
        Returns:
        an integer value for this NativeLong.

      • longValue

        public final long longValue()
        Returns an long representation of this NativeLong.
        Specified by:
        longValue in class java.lang.Number
        Returns:
        an long value for this NativeLong.

      • floatValue

        public final float floatValue()
        Returns an float representation of this NativeLong.
        Specified by:
        floatValue in class java.lang.Number
        Returns:
        an float value for this NativeLong.

      • doubleValue

        public final double doubleValue()
        Returns an double representation of this NativeLong.
        Specified by:
        doubleValue in class java.lang.Number
        Returns:
        an double value for this NativeLong.

      • hashCode

        public final int hashCode()
        Gets a hash code for this NativeLong.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code for this NativeLong.

      • equals

        public final boolean equals​(java.lang.Object obj)
        Compares this NativeLong to another NativeLong.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the other NativeLong to compare to.
        Returns:
        true if this NativeLong is equal to the other NativeLong, else false.

      • toString

        public java.lang.String toString()
        Returns a string representation of this NativeLong.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this NativeLong.

      • compareTo

        public final int compareTo​(NativeLong other)
        Compares two NativeLong instances numerically.
        Specified by:
        compareTo in interface java.lang.Comparable<NativeLong>
        Parameters:
        other - the other NativeLong to compare to.
        Returns:
        0 if other is equal to this instance, -1 if this instance is numerically less than other or 1 if this instance is numerically greater than other.

      • _valueOf

        private static NativeLong _valueOf​(long value)

      • _valueOf

        private static NativeLong _valueOf​(int value)

      • valueOf

        public static NativeLong valueOf​(long value)
        Returns a NativeLong instance representing the specified long value
        Parameters:
        value - a long value
        Returns:
        a NativeLong instance representing value

      • valueOf

        public static NativeLong valueOf​(int value)
        Returns a NativeLong instance representing the specified int value
        Parameters:
        value - a 32bit integer value
        Returns:
        a NativeLong instance representing value