copilot-sdk-java/snapshot/jacoco/com.github.copilot.rpc/CommandDefinition.java.html at gh-pages · github/copilot-sdk-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>CommandDefinition.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">GitHub Copilot SDK :: Java</a> &gt; <a href="index.source.html" class="el_package">com.github.copilot.rpc</a> &gt; <span class="el_source">CommandDefinition.java</span></div><h1>CommandDefinition.java</h1><pre class="source lang-java linenums">/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

package com.github.copilot.rpc;

/**
 * Defines a slash command that users can invoke from the CLI TUI.
 * &lt;p&gt;
 * Register commands via {@link SessionConfig#setCommands(java.util.List)} or
 * {@link ResumeSessionConfig#setCommands(java.util.List)}. Each command appears
 * as {@code /name} in the CLI TUI.
 *
 * &lt;h2&gt;Example Usage&lt;/h2&gt;
 *
 * &lt;pre&gt;{@code
 * var config = new SessionConfig().setCommands(List.of(
 * 		new CommandDefinition().setName(&quot;deploy&quot;).setDescription(&quot;Deploy the application&quot;).setHandler(context -&gt; {
 * 			System.out.println(&quot;Deploying: &quot; + context.getArgs());
 * 			return CompletableFuture.completedFuture(null);
 * 		})));
 * }&lt;/pre&gt;
 *
 * @see CommandHandler
 * @see CommandContext
 * @since 1.0.0
 */
<span class="fc" id="L28">public class CommandDefinition {</span>

    private String name;
    private String description;
    private CommandHandler handler;

    /**
     * Gets the command name (without leading {@code /}).
     *
     * @return the command name
     */
    public String getName() {
<span class="fc" id="L40">        return name;</span>
    }

    /**
     * Sets the command name (without leading {@code /}).
     * &lt;p&gt;
     * For example, {@code &quot;deploy&quot;} registers the {@code /deploy} command.
     *
     * @param name
     *            the command name
     * @return this instance for method chaining
     */
    public CommandDefinition setName(String name) {
<span class="fc" id="L53">        this.name = name;</span>
<span class="fc" id="L54">        return this;</span>
    }

    /**
     * Gets the human-readable description shown in the command completion UI.
     *
     * @return the description, or {@code null} if not set
     */
    public String getDescription() {
<span class="fc" id="L63">        return description;</span>
    }

    /**
     * Sets the human-readable description shown in the command completion UI.
     *
     * @param description
     *            the description
     * @return this instance for method chaining
     */
    public CommandDefinition setDescription(String description) {
<span class="fc" id="L74">        this.description = description;</span>
<span class="fc" id="L75">        return this;</span>
    }

    /**
     * Gets the handler invoked when the command is executed.
     *
     * @return the command handler
     */
    public CommandHandler getHandler() {
<span class="fc" id="L84">        return handler;</span>
    }

    /**
     * Sets the handler invoked when the command is executed.
     *
     * @param handler
     *            the command handler
     * @return this instance for method chaining
     */
    public CommandDefinition setHandler(CommandHandler handler) {
<span class="fc" id="L95">        this.handler = handler;</span>
<span class="fc" id="L96">        return this;</span>
    }
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.14.202510111229</span></div></body></html>