Package ca.corefacility.bioinformatics.irida.model.workflow.description

Class IridaToolParameter

  • public class IridaToolParameter
extends java.lang.Object
    A parameter for a particular tool in a workflow.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static char PARAMETER_NAME_SEPARATOR
      A separator character for nested parameter names.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getParameterName()
      The name of the parameter to adjust.
      java.lang.String getToolId()
      The id of the tool to adjust.
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • PARAMETER_NAME_SEPARATOR

        public static final char PARAMETER_NAME_SEPARATOR
        A separator character for nested parameter names.
        See Also:
        Constant Field Values

    • Constructor Detail

      • IridaToolParameter

        public IridaToolParameter()

      • IridaToolParameter

        public IridaToolParameter​(java.lang.String toolId,
                          java.lang.String parameterName)
        Builds a new IridaToolParameter object with the given information.
        Parameters:
        toolId - The id of the tool to adjust the parameter.
        parameterName - The name of the parameter.

    • Method Detail

      • getToolId

        public java.lang.String getToolId()
        The id of the tool to adjust.
        Returns:
        The id of the tool with the parameter to set.

      • getParameterName

        public java.lang.String getParameterName()
        The name of the parameter to adjust.
        Returns:
        The name of the parameter to adjust.

      • 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

      • toString

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