bigint-crypto-utils/node_modules/xmlcreate/lib/nodes/XmlDtdParamEntityRef.d.ts

57 lines
1.7 KiB
TypeScript

/**
* Copyright (C) 2016-2019 Michael Kourlas
*
* 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.
*/
/**
* The options used to create a new parameter entity reference.
*/
export interface IXmlDtdParamEntityRefOptions {
/**
* The name of the entity to be referenced.
*/
name: string;
}
/**
* Represents a parameter entity reference in a document type definition.
*
* A parameter entity reference is structured as follows, where `{entity}`
* is the name of the entity:
*
* ```xml
* %{entity};
* ```
*/
export default class XmlDtdParamEntityRef<Parent> {
private readonly _validation;
private readonly _parent;
private _name;
constructor(parent: Parent, validation: boolean, options: IXmlDtdParamEntityRefOptions);
/**
* Gets the name of this parameter entity reference.
*/
get name(): string;
/**
* Sets the name of this parameter entity reference.
*/
set name(name: string);
/**
* Returns an XML string representation of this parameter entity reference.
*/
toString(): string;
/**
* Returns the parent of this parameter entity reference.
*/
up(): Parent;
}