Class XMLFacetInfoImpl

Hierarchy

AnnotableImpl
- XMLFacetInfoImpl

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new XMLFacetInfoImpl(nodeOrKey: IHighLevelNode | string, setAsTopLevel?: boolean): XMLFacetInfoImpl

Overwrites BasicNodeImpl.__constructor
- Defined in src/raml1/artifacts/raml10parser.ts:1275
Parameters
- nodeOrKey: IHighLevelNode | string
- Default value setAsTopLevel: boolean = true
Returns XMLFacetInfoImpl

Properties

_meta

_meta: NodeMetadataImpl

Protected _node

_node: IHighLevelNode

Protected nodeOrKey

nodeOrKey: IHighLevelNode | string

Protected setAsTopLevel

setAsTopLevel: boolean

Methods

RAMLVersion

RAMLVersion(): string

Implementation of XMLFacetInfo.RAMLVersion

Overwrites AnnotableImpl.RAMLVersion
- Defined in src/raml1/artifacts/raml10parser.ts:1385
Returns string

RAML version of the node

add

add(node: BasicNodeImpl): void

Inherited from BasicNodeImpl.add
- Defined in src/raml1/wrapped-ast/parserCore.ts:153
Append node as child

Parameters
- node: BasicNodeImpl
  
  node to be appended
Returns void

addToProp

addToProp(node: BasicNodeImpl, prop: string): void

Inherited from BasicNodeImpl.addToProp
- Defined in src/raml1/wrapped-ast/parserCore.ts:162
Append node as property value

Parameters
- node: BasicNodeImpl
  
  node to be set as property value
- prop: string
  
  name of property to set value for
Returns void

annotations

annotations(): AnnotationRef[]

Implementation of XMLFacetInfo.annotations

Inherited from AnnotableImpl.annotations
- Defined in src/raml1/artifacts/raml10parser.ts:149
Most of RAML model elements may have attached annotations decribing additional meta data about this element

Returns AnnotationRef[]

attribute

attribute(): boolean

Implementation of XMLFacetInfo.attribute

Overwrites BasicNodeImpl.attribute
- Defined in src/raml1/artifacts/raml10parser.ts:1282
If attribute is set to true, a type instance should be serialized as an XML attribute. It can only be true for scalar types.

Returns boolean

attributeDefaults

attributeDefaults(): boolean

Inherited from BasicNodeImpl.attributeDefaults
- Defined in src/raml1/wrapped-ast/parserCore.ts:385
Returns boolean

definition

definition(): ITypeDefinition

Implementation of XMLFacetInfo.definition

Inherited from BasicNodeImpl.definition
- Defined in src/raml1/wrapped-ast/parserCore.ts:316
Returns ITypeDefinition

object representing class of the node

dump

dump(): string

Inherited from BasicNodeImpl.dump
- Defined in src/raml1/wrapped-ast/parserCore.ts:180
Returns string

YAML string representing the node

errors

errors(): RamlParserError[]

Implementation of XMLFacetInfo.errors

Inherited from BasicNodeImpl.errors
- Defined in src/raml1/wrapped-ast/parserCore.ts:237
Returns RamlParserError[]

Array of errors

kind

kind(): string

Implementation of XMLFacetInfo.kind

Overwrites AnnotableImpl.kind
- Defined in src/raml1/artifacts/raml10parser.ts:1379
Returns string

Actual name of instance interface

meta

meta(): NodeMetadata

Implementation of XMLFacetInfo.meta

Inherited from BasicNodeImpl.meta
- Defined in src/raml1/wrapped-ast/parserCore.ts:389
Returns NodeMetadata

name

name(): string

Implementation of XMLFacetInfo.name
- Defined in src/raml1/artifacts/raml10parser.ts:1318
Allows to override the name of the XML element or XML attribute in it's XML representation.

Returns string

namespace

namespace(): string

Implementation of XMLFacetInfo.namespace
- Defined in src/raml1/artifacts/raml10parser.ts:1336
Allows to configure the name of the XML namespace.

Returns string

optional

optional(): boolean

Implementation of XMLFacetInfo.optional

Inherited from BasicNodeImpl.optional
- Defined in src/raml1/wrapped-ast/parserCore.ts:344
Returns boolean

Whether the element is an optional sibling of trait or resource type

optionalProperties

optionalProperties(): string[]

Implementation of XMLFacetInfo.optionalProperties

Inherited from BasicNodeImpl.optionalProperties
- Defined in src/raml1/wrapped-ast/parserCore.ts:352
Returns string[]

For siblings of traits or resource types returns an array of optional properties names.

parent

parent(): BasicNode

Implementation of XMLFacetInfo.parent

Inherited from BasicNodeImpl.parent
- Defined in src/raml1/wrapped-ast/parserCore.ts:56
Returns BasicNode

Direct ancestor in RAML hierarchy

prefix

prefix(): string

Implementation of XMLFacetInfo.prefix
- Defined in src/raml1/artifacts/raml10parser.ts:1354
Allows to configure the prefix which will be used during serialization to XML.

Returns string

remove

remove(node: BasicNodeImpl): void

Inherited from BasicNodeImpl.remove
- Defined in src/raml1/wrapped-ast/parserCore.ts:173
Remove node from children set

Parameters
- node: BasicNodeImpl
  
  node to be removed
Returns void

runtimeDefinition

runtimeDefinition(): ITypeDefinition

Implementation of XMLFacetInfo.runtimeDefinition

Inherited from BasicNodeImpl.runtimeDefinition
- Defined in src/raml1/wrapped-ast/parserCore.ts:323
Returns ITypeDefinition

for user class instances returns object representing actual user class

scalarsAnnotations

scalarsAnnotations(): XMLFacetInfoScalarsAnnotationsImpl

Implementation of XMLFacetInfo.scalarsAnnotations

Overwrites AnnotableImpl.scalarsAnnotations
- Defined in src/raml1/artifacts/raml10parser.ts:1391
Scalar properties annotations accessor

Returns XMLFacetInfoScalarsAnnotationsImpl

toAny

toAny(arg: any): any

Inherited from BasicNodeImpl.toAny
- Defined in src/raml1/wrapped-ast/parserCore.ts:196
Parameters
- arg: any
Returns any

toBoolean

toBoolean(arg: any): boolean

Inherited from BasicNodeImpl.toBoolean
- Defined in src/raml1/wrapped-ast/parserCore.ts:200
Parameters
- arg: any
Returns boolean

toJSON

toJSON(serializeOptions?: SerializeOptions): any

Inherited from BasicNodeImpl.toJSON
- Defined in src/raml1/wrapped-ast/parserCore.ts:330
Parameters
- Optional serializeOptions: SerializeOptions
Returns any

toNumber

toNumber(arg: any): any

Inherited from BasicNodeImpl.toNumber
- Defined in src/raml1/wrapped-ast/parserCore.ts:213
Parameters
- arg: any
Returns any

toString

toString(arg: any): string

Inherited from BasicNodeImpl.toString
- Defined in src/raml1/wrapped-ast/parserCore.ts:184
Parameters
- arg: any
Returns string

wrapped

wrapped(): boolean

Implementation of XMLFacetInfo.wrapped
- Defined in src/raml1/artifacts/raml10parser.ts:1300
If wrapped is set to true, a type instance should be wrapped in its own XML element. It can not be true for scalar types and it can not be true at the same moment when attribute is true.

Returns boolean

Generated using TypeDoc