org.raml.parser.rule

Class PojoTupleRule

java.lang.Object

org.raml.parser.rule.DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

org.raml.parser.rule.PojoTupleRule

All Implemented Interfaces:

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

Direct Known Subclasses:

ParamRule, SecurityReferenceRule

public class PojoTupleRule
extends DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

PojoTupleRule class.

Version:

$Id: $Id

Author:

kor

Field Summary

Fields inherited from class org.raml.parser.rule.DefaultTupleRule

rules

Constructor Summary

Constructors

Constructor and Description
PojoTupleRule(String fieldName, Class<?> pojoClass) Constructor for PojoTupleRule.
PojoTupleRule(String fieldName, Class<?> pojoClass, NodeRuleFactory nodeRuleFactory) Constructor for PojoTupleRule.

Method Summary

Modifier and Type	Method and Description
TupleRule<?,?>	getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple) getRuleForTuple.
Class<?>[]	getValueNodeType() getValueNodeType.
void	setValueType(Type valueType) setValueType.
List<ValidationResult>	validateKey(org.yaml.snakeyaml.nodes.ScalarNode key) validateKey.

Methods inherited from class org.raml.parser.rule.DefaultTupleRule

addRulesFor, doValidateValue, getHandler, getKey, getName, getNodeRuleFactory, getParentTupleRule, getRootTupleRule, getRuleByFieldName, isRequired, isValidValueNodeType, onRuleEnd, setHandler, setName, setNestedRules, setNodeRuleFactory, setParentTupleRule, setRequired, validateValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PojoTupleRule

public PojoTupleRule(String fieldName,
                     Class<?> pojoClass,
                     NodeRuleFactory nodeRuleFactory)

Constructor for PojoTupleRule.

Parameters:

fieldName - a String object.

pojoClass - a Class object.

nodeRuleFactory - a NodeRuleFactory object.

PojoTupleRule

public PojoTupleRule(String fieldName,
                     Class<?> pojoClass)

Constructor for PojoTupleRule.

Parameters:

fieldName - a String object.

pojoClass - a Class object.

Method Detail

getRuleForTuple

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

getRuleForTuple.

Specified by:

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

Overrides:

getRuleForTuple in class DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

Parameters:

nodeTuple - a NodeTuple object.

Returns:

a TupleRule object.

getValueNodeType

public Class<?>[] getValueNodeType()

getValueNodeType.

Overrides:

getValueNodeType in class DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

Returns:

an array of Class objects.

setValueType

public void setValueType(Type valueType)

setValueType.

Specified by:

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

Overrides:

setValueType in class DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

Parameters:

valueType - a Type object.

validateKey

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

validateKey.

Specified by:

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

Overrides:

validateKey in class DefaultTupleRule<org.yaml.snakeyaml.nodes.ScalarNode,org.yaml.snakeyaml.nodes.MappingNode>

Parameters:

key - a ScalarNode object.

Returns:

a List object.