org.raml.parser.visitor

Class YamlDocumentValidator

java.lang.Object

org.raml.parser.visitor.YamlDocumentValidator

All Implemented Interfaces:

ResourceLoaderAware, ContextPathAware, NodeHandler, YamlValidator

Direct Known Subclasses:

RamlDocumentValidator

public class YamlDocumentValidator
extends Object
implements YamlValidator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YamlDocumentValidator(Class<?> documentClass)
protected	YamlDocumentValidator(Class<?> documentClass, NodeRuleFactory nodeRuleFactory)

Method Summary

Modifier and Type	Method and Description
ContextPath	getContextPath()
List<ValidationResult>	getMessages()
protected ResourceLoader	getResourceLoader()
protected Stack<NodeRule<?>>	getRuleContext()
void	onCustomTagEnd(org.yaml.snakeyaml.nodes.Tag tag, org.yaml.snakeyaml.nodes.Node originalValueNode, org.yaml.snakeyaml.nodes.Node node)
void	onCustomTagError(org.yaml.snakeyaml.nodes.Tag tag, org.yaml.snakeyaml.nodes.Node node, String message)
void	onCustomTagStart(org.yaml.snakeyaml.nodes.Tag tag, org.yaml.snakeyaml.nodes.Node originalValueNode, org.yaml.snakeyaml.nodes.Node node)
void	onDocumentEnd(org.yaml.snakeyaml.nodes.MappingNode node)
boolean	onDocumentStart(org.yaml.snakeyaml.nodes.MappingNode node) This method is call when a document node 'event' is reached
void	onMappingNodeEnd(org.yaml.snakeyaml.nodes.MappingNode node, TupleType tupleType)
boolean	onMappingNodeStart(org.yaml.snakeyaml.nodes.MappingNode node, TupleType tupleType) This method is call when a mapping node 'event' is reached
void	onScalar(org.yaml.snakeyaml.nodes.ScalarNode node, TupleType tupleType)
void	onSequenceElementEnd(org.yaml.snakeyaml.nodes.Node sequenceNode)
void	onSequenceElementStart(org.yaml.snakeyaml.nodes.Node sequenceNode)
void	onSequenceEnd(org.yaml.snakeyaml.nodes.SequenceNode node, TupleType tupleType)
boolean	onSequenceStart(org.yaml.snakeyaml.nodes.SequenceNode node, TupleType tupleType) This method is call when a sequence node 'event' is reached
void	onTupleEnd(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)
boolean	onTupleStart(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)
void	setContextPath(ContextPath contextPath)
void	setResourceLoader(ResourceLoader resourceLoader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamlDocumentValidator

protected YamlDocumentValidator(Class<?> documentClass)

YamlDocumentValidator

protected YamlDocumentValidator(Class<?> documentClass,
                                NodeRuleFactory nodeRuleFactory)

Method Detail

getRuleContext

protected Stack<NodeRule<?>> getRuleContext()

onMappingNodeStart

public boolean onMappingNodeStart(org.yaml.snakeyaml.nodes.MappingNode node,
                                  TupleType tupleType)

Description copied from interface: NodeHandler

This method is call when a mapping node 'event' is reached

Specified by:

onMappingNodeStart in interface NodeHandler

Parameters:

node - The mapping node

tupleType - If is part of Key or A Value in the container Node.

Returns:

should keep on visiting it's children

onMappingNodeEnd

public void onMappingNodeEnd(org.yaml.snakeyaml.nodes.MappingNode node,
                             TupleType tupleType)

Specified by:

onMappingNodeEnd in interface NodeHandler

onSequenceStart

public boolean onSequenceStart(org.yaml.snakeyaml.nodes.SequenceNode node,
                               TupleType tupleType)

Description copied from interface: NodeHandler

This method is call when a sequence node 'event' is reached

Specified by:

onSequenceStart in interface NodeHandler

Parameters:

node - The sequenceNode node

tupleType - If is part of Key or A Value in the container Node.

Returns:

should keep on visiting it's elements

See Also:

NodeHandler.onSequenceElementEnd(org.yaml.snakeyaml.nodes.Node)

onSequenceEnd

public void onSequenceEnd(org.yaml.snakeyaml.nodes.SequenceNode node,
                          TupleType tupleType)

Specified by:

onSequenceEnd in interface NodeHandler

onScalar

public void onScalar(org.yaml.snakeyaml.nodes.ScalarNode node,
                     TupleType tupleType)

Specified by:

onScalar in interface NodeHandler

onDocumentStart

public boolean onDocumentStart(org.yaml.snakeyaml.nodes.MappingNode node)

Description copied from interface: NodeHandler

This method is call when a document node 'event' is reached

Specified by:

onDocumentStart in interface NodeHandler

Parameters:

node - The documentNode node

Returns:

should keep on visiting it's children

onDocumentEnd

public void onDocumentEnd(org.yaml.snakeyaml.nodes.MappingNode node)

Specified by:

onDocumentEnd in interface NodeHandler

onTupleEnd

public void onTupleEnd(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)

Specified by:

onTupleEnd in interface NodeHandler

onTupleStart

public boolean onTupleStart(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)

Specified by:

onTupleStart in interface NodeHandler

onSequenceElementStart

public void onSequenceElementStart(org.yaml.snakeyaml.nodes.Node sequenceNode)

Specified by:

onSequenceElementStart in interface NodeHandler

onSequenceElementEnd

public void onSequenceElementEnd(org.yaml.snakeyaml.nodes.Node sequenceNode)

Specified by:

onSequenceElementEnd in interface NodeHandler

onCustomTagStart

public void onCustomTagStart(org.yaml.snakeyaml.nodes.Tag tag,
                             org.yaml.snakeyaml.nodes.Node originalValueNode,
                             org.yaml.snakeyaml.nodes.Node node)

Specified by:

onCustomTagStart in interface NodeHandler

onCustomTagEnd

public void onCustomTagEnd(org.yaml.snakeyaml.nodes.Tag tag,
                           org.yaml.snakeyaml.nodes.Node originalValueNode,
                           org.yaml.snakeyaml.nodes.Node node)

Specified by:

onCustomTagEnd in interface NodeHandler

onCustomTagError

public void onCustomTagError(org.yaml.snakeyaml.nodes.Tag tag,
                             org.yaml.snakeyaml.nodes.Node node,
                             String message)

Specified by:

onCustomTagError in interface NodeHandler

getMessages

public List<ValidationResult> getMessages()

Specified by:

getMessages in interface YamlValidator

setContextPath

public void setContextPath(ContextPath contextPath)

Specified by:

setContextPath in interface ContextPathAware

getContextPath

public ContextPath getContextPath()

Specified by:

getContextPath in interface ContextPathAware

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

getResourceLoader

protected ResourceLoader getResourceLoader()