org.raml.parser.rule

Interface TupleRule<K extends org.yaml.snakeyaml.nodes.Node,V extends org.yaml.snakeyaml.nodes.Node>

All Superinterfaces:

NodeRule<V>

All Known Implementing Classes:

BaseUriRule, ContributionTupleRule, DefaultTupleRule, EnumModifierRule, GlobalSchemasRule, ImplicitMapEntryRule, MapTupleRule, MapWithListValueTupleRule, ParamRule, PojoTupleRule, SchemaRule, SecurityReferenceRule, SecurityReferenceSequenceRule, SequenceTupleNullsAllowedRule, SequenceTupleRule, SimpleNullAllowedRule, SimpleRule, UnknownTupleRule, UriParametersRule

public interface TupleRule<K extends org.yaml.snakeyaml.nodes.Node,V extends org.yaml.snakeyaml.nodes.Node>
extends NodeRule<V>

TupleRule interface.

Version:

$Id: $Id

Author:

kor

Method Summary

Modifier and Type	Method and Description
TupleHandler	getHandler() getHandler.
K	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.
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(K key) validateKey.

Methods inherited from interface org.raml.parser.rule.NodeRule

onRuleEnd, validateValue

Method Detail

validateKey

List<ValidationResult> validateKey(K key)

validateKey.

Parameters:

key - a K object.

Returns:

a List object.

getRuleForTuple

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

getRuleForTuple.

Parameters:

nodeTuple - a NodeTuple object.

Returns:

a TupleRule object.

setParentTupleRule

void setParentTupleRule(TupleRule<?,?> parent)

setParentTupleRule.

Parameters:

parent - a TupleRule object.

getParentTupleRule

TupleRule<?,?> getParentTupleRule()

getParentTupleRule.

Returns:

a TupleRule object.

getRootTupleRule

TupleRule<?,?> getRootTupleRule()

getRootTupleRule.

Returns:

a TupleRule object.

getName

String getName()

getName.

Returns:

a String object.

setName

void setName(String name)

setName.

Parameters:

name - a String object.

getRuleByFieldName

TupleRule<?,?> getRuleByFieldName(String fieldName)

getRuleByFieldName.

Parameters:

fieldName - a String object.

Returns:

a TupleRule object.

setNestedRules

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

setNestedRules.

Parameters:

innerBuilders - a Map object.

setHandler

void setHandler(TupleHandler tupleHandler)

setHandler.

Parameters:

tupleHandler - a TupleHandler object.

getHandler

TupleHandler getHandler()

getHandler.

Returns:

a TupleHandler object.

setRequired

void setRequired(boolean required)

setRequired.

Parameters:

required - a boolean.

setNodeRuleFactory

void setNodeRuleFactory(NodeRuleFactory nodeRuleFactory)

setNodeRuleFactory.

Parameters:

nodeRuleFactory - a NodeRuleFactory object.

getKey

K getKey()

getKey.

Returns:

a K object.

setValueType

void setValueType(Type valueType)

setValueType.

Parameters:

valueType - a Type object.