Package com.priint.pubserver.plugin

Class PluginMethod

java.lang.Object
com.priint.pubserver.plugin.PluginMethod
All Implemented Interfaces:
Serializable
public class PluginMethod extends Object implements Serializable
TODO documentation missing
See Also:

  • Field Details

  • Constructor Details

    • PluginMethod

      public PluginMethod()

  • Method Details

    • getPluginMappedName

      public String getPluginMappedName()

    • setPluginMappedName

      public void setPluginMappedName(String pluginMappedName)

    • getMethodName

      public String getMethodName()

    • setMethodName

      public void setMethodName(String methodName)

    • getReturnType

      public String getReturnType()

    • setReturnType

      public void setReturnType(String returnType)

    • getReturnTypeArguments

      public List<String> getReturnTypeArguments()

    • setReturnTypeArguments

      public void setReturnTypeArguments(List<String> returnTypeArguments)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • getType

      public PluginMethod.MethodType getType()

    • setType

      public void setType(PluginMethod.MethodType type)

    • getKey

      public String getKey()

    • getSignature

      public String getSignature()

    • getParameters

      public List<PluginMethod.Parameter> getParameters()

    • setParameters

      public void setParameters(List<PluginMethod.Parameter> parameters)

    • addParameter

      public void addParameter(PluginMethod.Parameter parameter)

    • createCopy

      public PluginMethod createCopy()

    • threadSafeCopy

      public PluginMethod threadSafeCopy()

    • hasSameSignature

      public boolean hasSameSignature(PluginMethod other)

    • hasSameMethodName

      public boolean hasSameMethodName(PluginMethod other)

    • hasSameParametersSize

      public boolean hasSameParametersSize(PluginMethod other)

    • hasSameParametersTypes

      public boolean hasSameParametersTypes(PluginMethod other)

    • getLog

      public PluginMethod.LogSettings getLog()

    • setLog

      public void setLog(PluginMethod.LogSettings log)

    • getLabel

      public String getLabel()

    • setLabel

      public void setLabel(String label)

    • getAnnotations

      public Annotation[] getAnnotations()

    • setAnnotations

      public void setAnnotations(Annotation[] annotations)

    • getAnnotation

      public <T extends Annotation> T getAnnotation(Class<T> clazz)

    • getDefaultLogSettings

      public static PluginMethod.LogSettings getDefaultLogSettings()

    • setNthParameterValue

      public void setNthParameterValue(Object value, int index)

    • setFirstParameterValue

      public void setFirstParameterValue(Object value)

    • setLastParameterValue

      public void setLastParameterValue(Object value)

    • setNamedParameterValue

      public void setNamedParameterValue(Object value, String parameterName)

    • getNthParameterValue

      public Object getNthParameterValue(int index)

    • getFirstParameterValue

      public Object getFirstParameterValue()

    • getLastParameterValue

      public Object getLastParameterValue()

    • getNamedParameterValue

      public Object getNamedParameterValue(String parameterName)

    • getParameterByName

      public PluginMethod.Parameter getParameterByName(String parameterName)

    • getCallString

      public String getCallString()

    • show

      public void show()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • quote

      public static String quote(PluginMethod.Parameter parameter)

    • quote

      public static String quote(String value)

    • paramType

      public static PluginMethod.ParamType paramType(PluginMethod.Parameter parameter)

    • paramType

      public static PluginMethod.ParamType paramType(String type)

    • 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(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(String value)

    • booleanValue

      public static String booleanValue(PluginMethod.Parameter parameter)

    • integerValue

      public static String integerValue(PluginMethod.Parameter parameter)

    • realValue

      public static String realValue(PluginMethod.Parameter parameter)

    • paramValue

      public static String paramValue(PluginMethod.Parameter parameter)

    • getComment

      public String getComment()

    • setComment

      public void setComment(String comment)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object