org.raml.parser.rule

Class DefaultTupleRule<K extends org.yaml.snakeyaml.nodes.Node,V extends org.yaml.snakeyaml.nodes.Node>

java.lang.Object

org.raml.parser.rule.DefaultTupleRule<K,V>

All Implemented Interfaces:

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

Direct Known Subclasses:

ImplicitMapEntryRule, MapTupleRule, MapWithListValueTupleRule, PojoTupleRule, SequenceTupleRule, SimpleRule, UnknownTupleRule, UriParametersRule

public class DefaultTupleRule<K extends org.yaml.snakeyaml.nodes.Node,V extends org.yaml.snakeyaml.nodes.Node>
extends Object
implements TupleRule<K,org.yaml.snakeyaml.nodes.Node>

DefaultTupleRule class.

Version:

$Id: $Id

Author:

kor

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,TupleRule<?,?>>	rules

Constructor Summary

Constructors

Constructor and Description
DefaultTupleRule() Constructor for DefaultTupleRule.
DefaultTupleRule(String name, TupleHandler handler) Constructor for DefaultTupleRule.
DefaultTupleRule(String name, TupleHandler handler, NodeRuleFactory nodeRuleFactory) Constructor for DefaultTupleRule.

Method Summary

Modifier and Type	Method and Description
void	addRulesFor(Class<?> pojoClass) addRulesFor.
List<ValidationResult>	doValidateValue(V value) doValidateValue.
TupleHandler	getHandler() getHandler.
K	getKey() Getter for the field key.
String	getName() Getter for the field name.
NodeRuleFactory	getNodeRuleFactory() Getter for the field nodeRuleFactory.
TupleRule<?,?>	getParentTupleRule() getParentTupleRule.
TupleRule<?,?>	getRootTupleRule() getRootTupleRule.
TupleRule<?,?>	getRuleByFieldName(String fieldName) getRuleByFieldName.
TupleRule<?,?>	getRuleForTuple(org.yaml.snakeyaml.nodes.NodeTuple nodeTuple) getRuleForTuple.
Class<?>[]	getValueNodeType() getValueNodeType.
boolean	isRequired() isRequired.
protected boolean	isValidValueNodeType(Class valueNodeClass) isValidValueNodeType.
List<ValidationResult>	onRuleEnd() onRuleEnd.
void	setHandler(TupleHandler tupleHandler) setHandler.
void	setName(String name) setName.
void	setNestedRules(Map<String,TupleRule<?,?>> rules) 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.
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

Field Detail

rules

protected Map<String,TupleRule<?,?>> rules

Constructor Detail

DefaultTupleRule

public DefaultTupleRule()

Constructor for DefaultTupleRule.

DefaultTupleRule

public DefaultTupleRule(String name,
                        TupleHandler handler,
                        NodeRuleFactory nodeRuleFactory)

Constructor for DefaultTupleRule.

Parameters:

name - a String object.

handler - a TupleHandler object.

nodeRuleFactory - a NodeRuleFactory object.

DefaultTupleRule

public DefaultTupleRule(String name,
                        TupleHandler handler)

Constructor for DefaultTupleRule.

Parameters:

name - a String object.

handler - a TupleHandler object.

Method Detail

isRequired

public boolean isRequired()

isRequired.

Returns:

a boolean.

setRequired

public void setRequired(boolean required)

setRequired.

Specified by:

setRequired in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

nodeRuleFactory - a NodeRuleFactory object.

setNestedRules

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

setNestedRules.

Specified by:

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

Parameters:

rules - a Map object.

setHandler

public void setHandler(TupleHandler tupleHandler)

setHandler.

Specified by:

setHandler in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a TupleHandler object.

validateKey

public List<ValidationResult> validateKey(K key)

validateKey.

Specified by:

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

Parameters:

key - a K object.

Returns:

a List object.

validateValue

public final 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.

doValidateValue

public List<ValidationResult> doValidateValue(V value)

doValidateValue.

Parameters:

value - a V object.

Returns:

a List object.

isValidValueNodeType

protected boolean isValidValueNodeType(Class valueNodeClass)

isValidValueNodeType.

Parameters:

valueNodeClass - a Class object.

Returns:

a boolean.

getValueNodeType

public Class<?>[] getValueNodeType()

getValueNodeType.

Returns:

an array of Class objects.

onRuleEnd

public List<ValidationResult> onRuleEnd()

onRuleEnd.

Specified by:

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

Returns:

a List object.

getKey

public K getKey()

Getter for the field key.

Specified by:

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

Returns:

a K object.

setName

public void setName(String name)

setName.

Specified by:

setName in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

valueType - a Type object.

addRulesFor

public void addRulesFor(Class<?> pojoClass)

addRulesFor.

Parameters:

pojoClass - a Class object.

getNodeRuleFactory

public NodeRuleFactory getNodeRuleFactory()

Getter for the field nodeRuleFactory.

Returns:

a NodeRuleFactory object.

getRuleForTuple

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

getRuleForTuple.

Specified by:

getRuleForTuple in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

parent - a TupleRule object.

getName

public String getName()

Getter for the field name.

Specified by:

getName in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Parameters:

fieldName - a String object.

Returns:

a TupleRule object.

getParentTupleRule

public TupleRule<?,?> getParentTupleRule()

getParentTupleRule.

Specified by:

getParentTupleRule in interface TupleRule<K extends 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<K extends org.yaml.snakeyaml.nodes.Node,org.yaml.snakeyaml.nodes.Node>

Returns:

a TupleRule object.