Class MethodDefinition


  • public final class MethodDefinition
    extends Object
    Describes an Interop method.
    • Method Detail

      • forName

        public static MethodDefinition forName​(String method)
        Builds a method definition for specified name.
        Parameters:
        method - name of the method, must not be null
        Returns:
        a method definition
      • getName

        public String getName()
        Returns the name of the method.
        Returns:
        the name of the method, never null
      • getObjectTypes

        public Set<String> getObjectTypes()
        Returns the entities this method is meant to work with.
        Returns:
        the entities this method is meant to work with, never null
      • getMetadata

        public Map<String,​Object> getMetadata()
        Returns additional metadata key-value pairs.
        Returns:
        additional metadata key-value pairs, never null
        Since:
        1.4.3
      • getDescription

        public String getDescription()
        Returns a description of what the method does.
        Returns:
        a description of what the method does, may be null
      • getDisplayName

        public String getDisplayName()
      • getAccepts

        public String getAccepts()
        Returns the signature of accepted arguments.
        Returns:
        the signature of accepted arguments, may be null
        Since:
        1.2
      • getReturns

        public String getReturns()
        Returns the signature of returned result.
        Returns:
        signature of returned result, may be null
        Since:
        1.2