org.raml.parser.rule
Class ContributionTupleRule

java.lang.Object
  extended by 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>


Constructor Summary
ContributionTupleRule(TupleRule rule, List<TupleRule> contributionRules)
           
 
Method Summary
 TupleHandler getHandler()
           
 org.yaml.snakeyaml.nodes.Node getKey()
           
 String getName()
           
 TupleRule<?,?> getParentTupleRule()
           
 TupleRule<?,?> getRootTupleRule()
           
 TupleRule<?,?> getRuleByFieldName(String fieldName)
           
 TupleRule<?,?> getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)
           
 List<ValidationResult> onRuleEnd()
          Called when the ruled was ended to verify all mandatory fields are present
 void setHandler(TupleHandler tupleHandler)
           
 void setName(String name)
           
 void setNestedRules(Map<String,TupleRule<?,?>> innerBuilders)
           
 void setNodeRuleFactory(NodeRuleFactory nodeRuleFactory)
           
 void setParentTupleRule(TupleRule<?,?> parent)
           
 void setRequired(boolean required)
           
 void setValueType(Type valueType)
           
 List<ValidationResult> validateKey(org.yaml.snakeyaml.nodes.Node key)
           
 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)
Method Detail

validateKey

public List<ValidationResult> validateKey(org.yaml.snakeyaml.nodes.Node key)
Specified by:
validateKey in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getRuleForTuple

public TupleRule<?,?> getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple)
Specified by:
getRuleForTuple in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setParentTupleRule

public void setParentTupleRule(TupleRule<?,?> parent)
Specified by:
setParentTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getParentTupleRule

public TupleRule<?,?> getParentTupleRule()
Specified by:
getParentTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getRootTupleRule

public TupleRule<?,?> getRootTupleRule()
Specified by:
getRootTupleRule in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getName

public String getName()
Specified by:
getName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getRuleByFieldName

public TupleRule<?,?> getRuleByFieldName(String fieldName)
Specified by:
getRuleByFieldName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setNestedRules

public void setNestedRules(Map<String,TupleRule<?,?>> innerBuilders)
Specified by:
setNestedRules in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setHandler

public void setHandler(TupleHandler tupleHandler)
Specified by:
setHandler in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getHandler

public TupleHandler getHandler()
Specified by:
getHandler in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setRequired

public void setRequired(boolean required)
Specified by:
setRequired in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setNodeRuleFactory

public void setNodeRuleFactory(NodeRuleFactory nodeRuleFactory)
Specified by:
setNodeRuleFactory in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

getKey

public org.yaml.snakeyaml.nodes.Node getKey()
Specified by:
getKey in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setName

public void setName(String name)
Specified by:
setName in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

setValueType

public void setValueType(Type valueType)
Specified by:
setValueType in interface TupleRule<org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

validateValue

public List<ValidationResult> validateValue(org.yaml.snakeyaml.nodes.Node value)
Description copied from interface: NodeRule
Validates the given value

Specified by:
validateValue in interface NodeRule<org.yaml.snakeyaml.nodes.Node>
Parameters:
value - The value to validate
Returns:

onRuleEnd

public List<ValidationResult> onRuleEnd()
Description copied from interface: NodeRule
Called when the ruled was ended to verify all mandatory fields are present

Specified by:
onRuleEnd in interface NodeRule<org.yaml.snakeyaml.nodes.Node>
Returns:


Copyright © 2013. All rights reserved.