AltRepParam.ts 2.45 KB
Newer Older
Mark Stenglein's avatar
Mark Stenglein committed
1 2
/*
 * lib-ical
Mark Stenglein's avatar
Mark Stenglein committed
3
 * Copyright (C) 2017 Mark Stenglein
Mark Stenglein's avatar
Mark Stenglein committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
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
import Parameter from "./Parameter";

/**
 * Implements the Alternate text representation parameter
 *
 *  Format Definition: This property parameter is defined by the
 *    following notation:
 *
 *      altrepparam = "ALTREP" "=" DQUOTE uri DQUOTE
 *
 * This parameter specifies a URI that points to an alternate representation
 *   for a textual property value.
 *
 * A property specifying this parameter MUST also include a value that reflects
 *   the default representation of the text value.
 *
 * The URI parameter value MUST be specified in a quoted-string.
 *
 * @author Mark Stenglein <mark@stengle.in>
 */
export default class AltRepParam extends Parameter {
    private _uri: string;

    constructor(uri: string) {
        if (!uri) {
            throw new TypeError("uri must be defined for AltRepParam");
        }
        else {
            super("ALTREP", []);
            this.uri = uri;
            this.reqContentValue = true;
        }
    }

    get uri(): string {
        return this._uri;
    }

    /**
     * Allows you to set the parameter with either a quoted-string or a
     *   QSAFE-CHAR, which will be converted into a quoted-string
     *
     * @author Mark Stenglein <mark@stengle.in>
     * @since 0.1.0
     * @param newUri string value of the new URI which is to be validated
     * @returns void
     * @access public
     */
    set uri(newUri: string) {
        if (Parameter.isQSafeChar(newUri)) {
            this._uri = newUri;
            this.paramValues = ["\"" + this.uri + "\""];
        }
        else if (Parameter.isQuotedString(newUri)) {
            this._uri = newUri;
            this.paramValues = [newUri];
        }
        else {
            throw new TypeError("URI must be QSAFE-CHAR or quoted-string");
        }
    }
}