This repository has been archived by the owner on Nov 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
/
AbstractCommandBuilder.ts
61 lines (56 loc) · 2.14 KB
/
AbstractCommandBuilder.ts
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
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { ICommandDefinition } from "../../";
/**
* profile.schema Command Builder - used in the module loaders to build and append additional profile.schemaside commands as
* requested by the module definition.
*/
export abstract class AbstractCommandBuilder {
/**
* Accepts an instance of this class and builds the definition and appends it to the command definition document.
* @param { AbstractCommandBuilder} builder: The builder that constructs the definition.
* @param {ICommandDefinition} definition: The definition to append to.
* command will be appended to the existing group.
*/
public static appendToDocument(builder: AbstractCommandBuilder, definition: ICommandDefinition): void {
const actions: ICommandDefinition[] = definition.children;
for (const child of actions) {
if (child.name === builder.getAction()) {
if (child.children) {
child.children.push(builder.build());
} else {
child.children = [builder.build()];
}
return;
}
}
if (definition.children) {
definition.children.push(builder.buildFull());
} else {
definition.children = [builder.buildFull()];
}
}
/**
* Gets the "action" that this command builder is building.
* @return {string}: The action command group string.
*/
public abstract getAction(): string;
/**
* Build the full command - includes action group and object command.
* @return {ICommandDefinition}: The command definition.
*/
public abstract buildFull(): ICommandDefinition;
/**
* Only constructs the object command.
* @return {ICommandDefinition}: The object command definition.
*/
public abstract build(): ICommandDefinition;
}