Package com.priint.pubserver.plugin

Class PluginMethod

  • All Implemented Interfaces:
    java.io.Serializable
    public class PluginMethod
extends java.lang.Object
implements java.io.Serializable
    TODO documentation missing
    See Also:
    Serialized Form

    • Field Detail

      • pluginMappedName

        protected java.lang.String pluginMappedName

      • methodName

        protected java.lang.String methodName

      • label

        protected java.lang.String label

      • returnType

        protected java.lang.String returnType

      • returnTypeArguments

        protected java.util.List<java.lang.String> returnTypeArguments

      • description

        protected java.lang.String description

      • annotations

        protected java.lang.annotation.Annotation[] annotations

      • PLUGINMETHOD_CALL_LOGLEVEL_SYSPROPERTY

        public static final java.lang.String PLUGINMETHOD_CALL_LOGLEVEL_SYSPROPERTY
        See Also:
        Constant Field Values

      • PLUGINMETHOD_PARAMETERS_LOGLEVEL_SYSPROPERTY

        public static final java.lang.String PLUGINMETHOD_PARAMETERS_LOGLEVEL_SYSPROPERTY
        See Also:
        Constant Field Values

      • PLUGINMETHOD_CONSTANTS_LOGLEVEL_SYSPROPERTY

        public static final java.lang.String PLUGINMETHOD_CONSTANTS_LOGLEVEL_SYSPROPERTY
        See Also:
        Constant Field Values

      • PLUGINMETHOD_RESULT_LOGLEVEL_SYSPROPERTY

        public static final java.lang.String PLUGINMETHOD_RESULT_LOGLEVEL_SYSPROPERTY
        See Also:
        Constant Field Values

      • PLUGINMETHOD_EXCEPTIONS_LOGLEVEL_SYSPROPERTY

        public static final java.lang.String PLUGINMETHOD_EXCEPTIONS_LOGLEVEL_SYSPROPERTY
        See Also:
        Constant Field Values

    • Constructor Detail

      • PluginMethod

        public PluginMethod()

    • Method Detail

      • getPluginMappedName

        public java.lang.String getPluginMappedName()

      • setPluginMappedName

        public void setPluginMappedName​(java.lang.String pluginMappedName)

      • getMethodName

        public java.lang.String getMethodName()

      • setMethodName

        public void setMethodName​(java.lang.String methodName)

      • getReturnType

        public java.lang.String getReturnType()

      • setReturnType

        public void setReturnType​(java.lang.String returnType)

      • getReturnTypeArguments

        public java.util.List<java.lang.String> getReturnTypeArguments()

      • setReturnTypeArguments

        public void setReturnTypeArguments​(java.util.List<java.lang.String> returnTypeArguments)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • getKey

        public java.lang.String getKey()

      • getSignature

        public java.lang.String getSignature()

      • hasSameSignature

        public boolean hasSameSignature​(PluginMethod other)

      • hasSameMethodName

        public boolean hasSameMethodName​(PluginMethod other)

      • hasSameParametersSize

        public boolean hasSameParametersSize​(PluginMethod other)

      • hasSameParametersTypes

        public boolean hasSameParametersTypes​(PluginMethod other)

      • getLabel

        public java.lang.String getLabel()

      • setLabel

        public void setLabel​(java.lang.String label)

      • getAnnotations

        public java.lang.annotation.Annotation[] getAnnotations()

      • setAnnotations

        public void setAnnotations​(java.lang.annotation.Annotation[] annotations)

      • getAnnotation

        public <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> clazz)

      • setNthParameterValue

        public void setNthParameterValue​(java.lang.Object value,
                                 int index)

      • setFirstParameterValue

        public void setFirstParameterValue​(java.lang.Object value)

      • setLastParameterValue

        public void setLastParameterValue​(java.lang.Object value)

      • setNamedParameterValue

        public void setNamedParameterValue​(java.lang.Object value,
                                   java.lang.String parameterName)

      • getNthParameterValue

        public java.lang.Object getNthParameterValue​(int index)

      • getFirstParameterValue

        public java.lang.Object getFirstParameterValue()

      • getLastParameterValue

        public java.lang.Object getLastParameterValue()

      • getNamedParameterValue

        public java.lang.Object getNamedParameterValue​(java.lang.String parameterName)

      • getCallString

        public java.lang.String getCallString()

      • show

        public void show()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • quote

        public static java.lang.String quote​(java.lang.String value)

      • isTag

        public static boolean isTag​(PluginMethod.Parameter parameter)

        Determines, whether a given parameters defaultValue matches the pattern "^<[a-zA-Z0-9_.]+>$"

        Use this method to check, whether a value should be considered as Tag.

        Tag values are expected to be set either in the Constant Map provided to the ParameterInterpreter or in the dynamic parameter map passed to DataProviderManager calls.

        This method accepts a wide range of values as tags (e.g. <1>, <a.b.c> ...), though the naming recommendation for tags is 
                ^<[A-Z]+[a-zA-Z0-9]*(\.?[A-Z]+[a-zA-Z0-9]*>|>)$

        Parameters:
        parameter - parameter to check
        Returns:
        true, if the parameter default value is a tag, false otherwise or if parameter is null

      • isTag

        public static boolean isTag​(java.lang.String value)

        Determines, whether a given value matches the pattern "^<[a-zA-Z0-9_.]+>$"

        Use this method to check, whether a value should be considered as Tag.

        Tag values are expected to be set either in the Constant Map provided to the ParameterInterpreter or in the dynamic parameter map passed to DataProviderManager calls.

        This method accepts a wide range of values as tags (e.g. <1>, <a.b.c> ...), though the naming recommendation for tags is 

                ^<[A-Z]+[a-zA-Z0-9]*(\.?[A-Z]+[a-zA-Z0-9]*>|>)$

        Parameters:
        value - value to check
        Returns:
        true, if value is a tag, false otherwise

      • matchesTagNamingConvention

        public static boolean matchesTagNamingConvention​(java.lang.String value)

      • getComment

        public java.lang.String getComment()

      • setComment

        public void setComment​(java.lang.String comment)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object