Package 

Interface BlastCommand

  • All Implemented Interfaces:

    
    public interface BlastCommand
    
                        

    Blast Command Type Base

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract ObjectNode toJson() Serializes the current BlastCommand to a JSON ObjectNode.
      abstract String toCliString() Renders the current BlastCommand as a CLI call string.
      abstract Array<String> toCliArray() Converts the current BlastCommand to an array of strings making up a CLI call.
      abstract ErrorMap validate() Validates this Blast+ config checking for flags that are incompatible and values that are out of range or invalid.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • toJson

         abstract ObjectNode toJson()

        Serializes the current BlastCommand to a JSON ObjectNode.

        Only non-default properties and the "tool" property should be present in the output JSON.

      • toCliString

         abstract String toCliString()

        Renders the current BlastCommand as a CLI call string.

        Only non-default properties and the tool name should be present in the output string.

      • toCliArray

         abstract Array<String> toCliArray()

        Converts the current BlastCommand to an array of strings making up a CLI call.

        Only non-default properties and the tool name should be present in the output array.

      • validate

         abstract ErrorMap validate()

        Validates this Blast+ config checking for flags that are incompatible and values that are out of range or invalid.