org.raml.parser.rule

Class ContributionTupleRule

java.lang.Object

org.raml.parser.rule.ContributionTupleRule

All Implemented Interfaces:

NodeRule<org.yaml.snakeyaml.nodes.Node>, TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

public class ContributionTupleRule
extends Object
implements TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

ContributionTupleRule class.

Version:

$Id: $Id

Author:

kor

Constructor Summary

Constructors

Constructor and Description
ContributionTupleRule(TupleRule rule, List<TupleRule> contributionRules) Constructor for ContributionTupleRule.

Method Summary

Modifier and Type	Method and Description
TupleHandler	getHandler() getHandler.
org.yaml.snakeyaml.nodes.Node	getKey() getKey.
String	getName() getName.
TupleRule<?,?>	getParentTupleRule() getParentTupleRule.
TupleRule<?,?>	getRootTupleRule() getRootTupleRule.
TupleRule<?,?>	getRuleByFieldName(String fieldName) getRuleByFieldName.
TupleRule<?,?>	getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple) getRuleForTuple.
List<ValidationResult>	onRuleEnd() onRuleEnd.
void	setHandler(TupleHandler tupleHandler) setHandler.
void	setName(String name) setName.
void	setNestedRules(Map<String,TupleRule<?,?>> innerBuilders) setNestedRules.
void	setNodeRuleFactory(NodeRuleFactory nodeRuleFactory) setNodeRuleFactory.
void	setParentTupleRule(TupleRule<?,?> parent) setParentTupleRule.
void	setRequired(boolean required) setRequired.
void	setValueType(Type valueType) setValueType.
List<ValidationResult>	validateKey(org.yaml.snakeyaml.nodes.Node key) validateKey.
List<ValidationResult>	validateValue(org.yaml.snakeyaml.nodes.Node value) Validates the given value

Methods inherited from class java.lang.Object

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

Constructor Detail

ContributionTupleRule

public ContributionTupleRule(TupleRule rule,
                             List<TupleRule> contributionRules)

Constructor for ContributionTupleRule.

Parameters:

rule - a TupleRule object.

contributionRules - a List object.

Method Detail

validateKey

public List<ValidationResult> validateKey(org.yaml.snakeyaml.nodes.Node key)

validateKey.

Specified by:

validateKey in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

key - a K object.

Returns:

a List object.

getRuleForTuple

public TupleRule<?,?> getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)

getRuleForTuple.

Specified by:

getRuleForTuple in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

nodeTuple - a NodeTuple object.

Returns:

a TupleRule object.

setParentTupleRule

public void setParentTupleRule(TupleRule<?,?> parent)

setParentTupleRule.

Specified by:

setParentTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

parent - a TupleRule object.

getParentTupleRule

public TupleRule<?,?> getParentTupleRule()

getParentTupleRule.

Specified by:

getParentTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a TupleRule object.

getRootTupleRule

public TupleRule<?,?> getRootTupleRule()

getRootTupleRule.

Specified by:

getRootTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a TupleRule object.

getName

public String getName()

getName.

Specified by:

getName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a String object.

getRuleByFieldName

public TupleRule<?,?> getRuleByFieldName(String fieldName)

getRuleByFieldName.

Specified by:

getRuleByFieldName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

fieldName - a String object.

Returns:

a TupleRule object.

setNestedRules

public void setNestedRules(Map<String,TupleRule<?,?>> innerBuilders)

setNestedRules.

Specified by:

setNestedRules in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

innerBuilders - a Map object.

setHandler

public void setHandler(TupleHandler tupleHandler)

setHandler.

Specified by:

setHandler in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

tupleHandler - a TupleHandler object.

getHandler

public TupleHandler getHandler()

getHandler.

Specified by:

getHandler in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a TupleHandler object.

setRequired

public void setRequired(boolean required)

setRequired.

Specified by:

setRequired in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

required - a boolean.

setNodeRuleFactory

public void setNodeRuleFactory(NodeRuleFactory nodeRuleFactory)

setNodeRuleFactory.

Specified by:

setNodeRuleFactory in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

nodeRuleFactory - a NodeRuleFactory object.

getKey

public org.yaml.snakeyaml.nodes.Node getKey()

getKey.

Specified by:

getKey in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a Node object.

setName

public void setName(String name)

setName.

Specified by:

setName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

name - a String object.

setValueType

public void setValueType(Type valueType)

setValueType.

Specified by:

setValueType in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

valueType - a Type object.

validateValue

public List<ValidationResult> validateValue(org.yaml.snakeyaml.nodes.Node value)

Validates the given value

Specified by:

validateValue in interface NodeRule<org.yaml.snakeyaml.nodes.Node>

Parameters:

value - The value to validate

Returns:

a List object.

onRuleEnd

public List<ValidationResult> onRuleEnd()

onRuleEnd.

Specified by:

onRuleEnd in interface NodeRule<org.yaml.snakeyaml.nodes.Node>

Returns:

a List object.