fastman/lib/openapi-parser/models/3.0/link-parameter-expression.model.ts

快速api测试及文档生成

/**
 * @license
 * Copyright 2017 Red Hat
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {IOas30NodeVisitor, IOasNodeVisitor} from "../../visitors/visitor.iface";
import {OasNode} from "../node.model";

/**
 * Models an OAS 3.0 Link Parameter Expression object.
 */
export class Oas30LinkParameterExpression extends OasNode {

    private _name: string;
    private _value: string;

    /**
     * Constructor.
     * @param name
     * @param value
     */
    constructor(name: string, value: string) {
        super();
        this._name = name;
        this._value = value;
    }

    /**
     * Accepts the given OAS node visitor and calls the appropriate method on it to visit this node.
     * @param visitor
     */
    public accept(visitor: IOasNodeVisitor): void {
        let viz: IOas30NodeVisitor = visitor as IOas30NodeVisitor;
        viz.visitLinkParameterExpression(this);
    }

    /**
     * Gets the name of the expression.
     * @return {string}
     */
    public name(): string {
        return this._name;
    }

    /**
     * Get the expression value.
     * @return {string}
     */
    public value(): string {
        return this._value;
    }

    /**
     * Returns true if the expression is a dynamic link parameter expression that must be evaluated.
     * @return {boolean}
     */
    public isExpression(): boolean {
        return typeof this.value() === "string" && this.value().indexOf("$") === 0;
    }

    /**
     * Returns true if the expression is just a constant value.
     * @return {boolean}
     */
    public isConstant(): boolean {
        return !this.isExpression();
    }

}