org.raml.v2.model.v10.core

Interface BasicNode

All Superinterfaces:

AbstractWrapperNode

All Known Subinterfaces:

AbstractSecurityScheme, Annotable, Api, ArrayTypeDeclaration, BasicFragmentNode, BasicSecurityScheme, BooleanTypeDeclaration, CustomSecurityScheme, DateOnlyTypeDeclaration, DateTimeOnlyTypeDeclaration, DateTimeTypeDeclaration, DateTypeDeclaration, DigestSecurityScheme, DocumentationItem, ExampleSpec, Extension, FileTypeDeclaration, FragmentDeclaration, IntegerTypeDeclaration, Library, LibraryBase, Method, MethodBase, NumberTypeDeclaration, OAuth1SecurityScheme, OAuth1SecuritySchemeSettings, OAuth2SecurityScheme, OAuth2SecuritySchemeSettings, ObjectTypeDeclaration, Operation, Overlay, PassThroughSecurityScheme, Resource, ResourceBase, ResourceType, Response, SecuritySchemePart, SecuritySchemeSettings, StringTypeDeclaration, TimeOnlyTypeDeclaration, Trait, TypeDeclaration, UnionTypeDeclaration, UsesDeclaration, XMLFacetInfo

public interface BasicNode
extends AbstractWrapperNode

Method Summary

Methods

Modifier and Type	Method and Description
NodeMetadata	meta()
boolean	optional()
List<String>	optionalProperties()
BasicNode	parent()
Object	toJSON()

Method Detail

parent

BasicNode parent()

Returns:

Direct ancestor in RAML hierarchy

toJSON

Object toJSON()

optionalProperties

List<String> optionalProperties()

Returns:

For siblings of traits or resource types returns a list of optional properties names.

optional

boolean optional()

Returns:

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

meta

NodeMetadata meta()

Returns:

Metadata of the node itself and its scalara properties