Module com.ensarsarajcic.neovim.java.pluginhost
Package com.ensarsarajcic.neovim.java.pluginhost.opts

Record Class CommandOpts

java.lang.Object
java.lang.Record
com.ensarsarajcic.neovim.java.pluginhost.opts.CommandOpts
public record CommandOpts(String nargs, String complete, String description, boolean enableRange, String range, String count, String addr, boolean force, boolean bang, boolean bar, boolean register, boolean keepScript, boolean sync) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommandOpts(String nargs, String complete, String description, boolean enableRange, String range, String count, String addr, boolean force, boolean bang, boolean bar, boolean register, boolean keepScript, boolean sync)
    Creates an instance of a CommandOpts record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addr()
    Returns the value of the addr record component.
    boolean
    bang()
    Returns the value of the bang record component.
    boolean
    bar()
    Returns the value of the bar record component.
    String
    complete()
    Returns the value of the complete record component.
    String
    count()
    Returns the value of the count record component.
    String
    description()
    Returns the value of the description record component.
    boolean
    enableRange()
    Returns the value of the enableRange record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    force()
    Returns the value of the force record component.
    static CommandOpts
    fromAnnotation(NeovimCommand command)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    keepScript()
    Returns the value of the keepScript record component.
    String
    nargs()
    Returns the value of the nargs record component.
    String
    range()
    Returns the value of the range record component.
    boolean
    register()
    Returns the value of the register record component.
    boolean
    sync()
    Returns the value of the sync record component.
    Map<String,Object>
    toNeovimOptions()
     
    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

    • CommandOpts

      public CommandOpts(String nargs, String complete, String description, boolean enableRange, String range, String count, String addr, boolean force, boolean bang, boolean bar, boolean register, boolean keepScript, boolean sync)
      Creates an instance of a CommandOpts record class.
      Parameters:
      nargs - the value for the nargs record component
      complete - the value for the complete record component
      description - the value for the description record component
      enableRange - the value for the enableRange record component
      range - the value for the range record component
      count - the value for the count record component
      addr - the value for the addr record component
      force - the value for the force record component
      bang - the value for the bang record component
      bar - the value for the bar record component
      register - the value for the register record component
      keepScript - the value for the keepScript record component
      sync - the value for the sync record component

  • Method Details

    • fromAnnotation

      public static CommandOpts fromAnnotation(NeovimCommand command)

    • toNeovimOptions

      public Map<String,Object> toNeovimOptions()

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • nargs

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

    • complete

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

    • description

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

    • enableRange

      public boolean enableRange()
      Returns the value of the enableRange record component.
      Returns:
      the value of the enableRange record component

    • range

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

    • count

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

    • addr

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

    • force

      public boolean force()
      Returns the value of the force record component.
      Returns:
      the value of the force record component

    • bang

      public boolean bang()
      Returns the value of the bang record component.
      Returns:
      the value of the bang record component

    • bar

      public boolean bar()
      Returns the value of the bar record component.
      Returns:
      the value of the bar record component

    • register

      public boolean register()
      Returns the value of the register record component.
      Returns:
      the value of the register record component

    • keepScript

      public boolean keepScript()
      Returns the value of the keepScript record component.
      Returns:
      the value of the keepScript record component

    • sync

      public boolean sync()
      Returns the value of the sync record component.
      Returns:
      the value of the sync record component