org.raml.parser.rule

Class BaseUriRule

java.lang.Object

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

org.raml.parser.rule.SimpleRule

org.raml.parser.rule.BaseUriRule

All Implemented Interfaces:

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

public class BaseUriRule
extends SimpleRule

BaseUriRule class.

Version:

$Id: $Id

Author:

kor

Field Summary

Fields

Modifier and Type	Field and Description
static String	URI_NOT_VALID_MESSAGE Constant URI_NOT_VALID_MESSAGE="The baseUri element is not a valid URI"
static String	URI_PATTERN Constant URI_PATTERN="[.*]?\\{(\\w+)?\\}[.*]*"
static String	VERSION_NOT_PRESENT_MESSAGE Constant VERSION_NOT_PRESENT_MESSAGE="version parameter must exist in the API"{trunked}

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

rules

Constructor Summary

Constructors

Constructor and Description
BaseUriRule() Constructor for BaseUriRule.

Method Summary

Modifier and Type	Method and Description
List<ValidationResult>	doValidateValue(org.yaml.snakeyaml.nodes.ScalarNode node) doValidateValue.
String	getBaseUri() Getter for the field baseUri.
Set<String>	getParameters() Getter for the field parameters.
SimpleRule	getVersionRule() getVersionRule.

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

getFieldClass, getKeyNode, getValueNode, getValueNodeType, setFieldClass, setKeyNode, setValueNode, validateKey, 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

Field Detail

URI_NOT_VALID_MESSAGE

public static final String URI_NOT_VALID_MESSAGE

Constant URI_NOT_VALID_MESSAGE="The baseUri element is not a valid URI"

See Also:

Constant Field Values

VERSION_NOT_PRESENT_MESSAGE

public static final String VERSION_NOT_PRESENT_MESSAGE

Constant VERSION_NOT_PRESENT_MESSAGE="version parameter must exist in the API"{trunked}

See Also:

Constant Field Values

URI_PATTERN

public static final String URI_PATTERN

Constant URI_PATTERN="[.*]?\\{(\\w+)?\\}[.*]*"

See Also:

Constant Field Values

Constructor Detail

BaseUriRule

public BaseUriRule()

Constructor for BaseUriRule.

Method Detail

getBaseUri

public String getBaseUri()

Getter for the field baseUri.

Returns:

a String object.

getParameters

public Set<String> getParameters()

Getter for the field parameters.

Returns:

a Set object.

doValidateValue

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

doValidateValue.

Overrides:

doValidateValue in class SimpleRule

Parameters:

node - a ScalarNode object.

Returns:

a List object.

getVersionRule

public SimpleRule getVersionRule()

getVersionRule.

Returns:

a SimpleRule object.