org.raml.parser.rule

Class SimpleRule

java.lang.Object

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

org.raml.parser.rule.SimpleRule

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseUriRule, EnumModifierRule, SchemaRule, SimpleNullAllowedRule

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

SimpleRule class.

Version:

$Id: $Id

Author:

kor

Field Summary

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

rules

Constructor Summary

Constructors

Constructor and Description
SimpleRule(String fieldName, Class<?> fieldClass) Constructor for SimpleRule.

Method Summary

Modifier and Type	Method and Description
List<ValidationResult>	doValidateValue(org.yaml.snakeyaml.nodes.ScalarNode node) doValidateValue.
Class<?>	getFieldClass() Getter for the field fieldClass.
org.yaml.snakeyaml.nodes.ScalarNode	getKeyNode() Getter for the field keyNode.
org.yaml.snakeyaml.nodes.ScalarNode	getValueNode() Getter for the field valueNode.
Class<?>[]	getValueNodeType() getValueNodeType.
void	setFieldClass(Class<?> fieldClass) Setter for the field fieldClass.
void	setKeyNode(org.yaml.snakeyaml.nodes.ScalarNode rulePresent) Setter for the field keyNode.
void	setValueNode(org.yaml.snakeyaml.nodes.ScalarNode valueNode) Setter for the field valueNode.
List<ValidationResult>	validateKey(org.yaml.snakeyaml.nodes.ScalarNode key) validateKey.
boolean	wasAlreadyDefined() wasAlreadyDefined.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRule

public SimpleRule(String fieldName,
                  Class<?> fieldClass)

Constructor for SimpleRule.

Parameters:

fieldName - a String object.

fieldClass - a Class object.

Method Detail

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.ScalarNode>

Parameters:

key - a ScalarNode object.

Returns:

a List object.

doValidateValue

public List<ValidationResult> doValidateValue(org.yaml.snakeyaml.nodes.ScalarNode node)

doValidateValue.

Overrides:

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

Parameters:

node - a ScalarNode object.

Returns:

a List object.

getValueNodeType

public Class<?>[] getValueNodeType()

getValueNodeType.

Overrides:

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

Returns:

an array of Class objects.

wasAlreadyDefined

public boolean wasAlreadyDefined()

wasAlreadyDefined.

Returns:

a boolean.

setKeyNode

public void setKeyNode(org.yaml.snakeyaml.nodes.ScalarNode rulePresent)

Setter for the field keyNode.

Parameters:

rulePresent - a ScalarNode object.

getKeyNode

public org.yaml.snakeyaml.nodes.ScalarNode getKeyNode()

Getter for the field keyNode.

Returns:

a ScalarNode object.

getValueNode

public org.yaml.snakeyaml.nodes.ScalarNode getValueNode()

Getter for the field valueNode.

Returns:

a ScalarNode object.

setValueNode

public void setValueNode(org.yaml.snakeyaml.nodes.ScalarNode valueNode)

Setter for the field valueNode.

Parameters:

valueNode - a ScalarNode object.

getFieldClass

public Class<?> getFieldClass()

Getter for the field fieldClass.

Returns:

a Class object.

setFieldClass

public void setFieldClass(Class<?> fieldClass)

Setter for the field fieldClass.

Parameters:

fieldClass - a Class object.