Package org.cy3sbml.commands

Record Class Commands.Command

java.lang.Object
java.lang.Record
org.cy3sbml.commands.Commands.Command
Enclosing class:
Commands
public static record Commands.Command(String name, String description, String longDescription, String exampleJson, org.cytoscape.work.TaskFactory factory) extends Record
A command: its name in the namespace, descriptions, an example of its JSON result, and the task factory.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Command(String name, String description, String longDescription, String exampleJson, org.cytoscape.work.TaskFactory factory)
    Creates an instance of a Command record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    exampleJson()
    Returns the value of the exampleJson record component.
    org.cytoscape.work.TaskFactory
    factory()
    Returns the value of the factory record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    longDescription()
    Returns the value of the longDescription record component.
    String
    name()
    Returns the value of the name record component.
    Properties
    properties()
    The service properties that register the task factory as the command.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Command

      public Command(String name, String description, String longDescription, String exampleJson, org.cytoscape.work.TaskFactory factory)
      Creates an instance of a Command record class.
      Parameters:
      name - the value for the name record component
      description - the value for the description record component
      longDescription - the value for the longDescription record component
      exampleJson - the value for the exampleJson record component
      factory - the value for the factory record component

  • Method Details

    • properties

      public Properties properties()
      The service properties that register the task factory as the command.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • longDescription

      public String longDescription()
      Returns the value of the longDescription record component.
      Returns:
      the value of the longDescription record component

    • exampleJson

      public String exampleJson()
      Returns the value of the exampleJson record component.
      Returns:
      the value of the exampleJson record component

    • factory

      public org.cytoscape.work.TaskFactory factory()
      Returns the value of the factory record component.
      Returns:
      the value of the factory record component