Package jnr.ffi.provider

Class ParameterFlags

  • public final class ParameterFlags
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DIRECT
      When allocating memory for the parameter, allocate a persistent memory block
      static int IN
      Contents of the parameter memory will be copied from from java to native memory
      static int NULTERMINATE
      The contents of the java array should have a zero byte appended
      static int OUT
      Contents of the parameter memory will be copied from native memory back to java
      static int PINNED
      The java array memory should be pinned by the JVM during the function call
      static int TRANSIENT
      When allocating memory for the parameter, a temporary memory block can be used

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean isDirect​(int flags)  
      static boolean isFlag​(java.lang.annotation.Annotation annotation)
      Checks if the annotation is a recognised parameter flag.
      static boolean isIn​(int flags)  
      static boolean isNulTerminate​(int flags)  
      static boolean isOut​(int flags)  
      static boolean isPinned​(int flags)  
      static boolean isTransient​(int flags)  
      static int parse​(java.lang.annotation.Annotation annotation)  
      static int parse​(java.lang.annotation.Annotation[] annotations)  
      static int parse​(java.util.Collection<java.lang.annotation.Annotation> annotations)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • OUT

        public static final int OUT
        Contents of the parameter memory will be copied from native memory back to java
        See Also:
        Constant Field Values

      • IN

        public static final int IN
        Contents of the parameter memory will be copied from from java to native memory
        See Also:
        Constant Field Values

      • PINNED

        public static final int PINNED
        The java array memory should be pinned by the JVM during the function call
        See Also:
        Constant Field Values

      • NULTERMINATE

        public static final int NULTERMINATE
        The contents of the java array should have a zero byte appended
        See Also:
        Constant Field Values

      • TRANSIENT

        public static final int TRANSIENT
        When allocating memory for the parameter, a temporary memory block can be used
        See Also:
        Constant Field Values

      • DIRECT

        public static final int DIRECT
        When allocating memory for the parameter, allocate a persistent memory block
        See Also:
        Constant Field Values

    • Method Detail

      • parse

        public static int parse​(java.lang.annotation.Annotation annotation)

      • parse

        public static int parse​(java.lang.annotation.Annotation[] annotations)

      • parse

        public static int parse​(java.util.Collection<java.lang.annotation.Annotation> annotations)

      • isFlag

        public static boolean isFlag​(java.lang.annotation.Annotation annotation)
        Checks if the annotation is a recognised parameter flag.
        Parameters:
        annotation - the annotation to check.
        Returns:
        true if the annotation is a parameter flag

      • isPinned

        public static boolean isPinned​(int flags)

      • isTransient

        public static boolean isTransient​(int flags)

      • isDirect

        public static boolean isDirect​(int flags)

      • isNulTerminate

        public static boolean isNulTerminate​(int flags)

      • isOut

        public static boolean isOut​(int flags)

      • isIn

        public static boolean isIn​(int flags)