2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.valid;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
14 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
15 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
16 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
17 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
19 public class DataValidationException extends RuntimeException {
20 private static final long serialVersionUID = 1L;
22 public DataValidationException(final String message) {
26 public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final DataNodeContainer schema,
27 final Set<QName> childNodes, final Set<YangInstanceIdentifier.AugmentationIdentifier> augments) {
29 throw new IllegalChildException(child, schema, childNodes, augments);
33 public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final DataSchemaNode schema,
34 final Set<QName> childNodes) {
36 throw new IllegalChildException(child, schema, childNodes);
40 public static void checkLegalChild(final boolean isLegal, final YangInstanceIdentifier.PathArgument child, final ChoiceNode schema) {
42 throw new IllegalChildException(child, schema);
46 public static void checkLegalData(final boolean isLegal, final String messageTemplate, final Object... messageAttrs) {
48 throw new DataValidationException(String.format(messageTemplate, messageAttrs));
52 public static void checkListKey(final DataContainerChild<?, ?> childNode, final Map<QName, Object> keyValues, final QName keyQName,
53 final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeId) {
54 checkListKey(childNode, keyQName, nodeId);
56 Object expectedValue = nodeId.getKeyValues().get(keyQName);
57 Object actualValue = childNode.getValue();
60 public static void checkListKey(final DataContainerChild<?, ?> childNode, final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeId) {
61 if (childNode == null) {
62 throw new IllegalListKeyException(keyQName, nodeId);
66 static final class IllegalChildException extends DataValidationException {
67 private static final long serialVersionUID = 1L;
69 public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final DataNodeContainer schema,
70 final Set<QName> childNodes, final Set<YangInstanceIdentifier.AugmentationIdentifier> augments) {
71 super(String.format("Unknown child node: %s, does not belong to: %s as a direct child. "
72 + "Direct child nodes: %s, augmented child nodes: %s", child, schema, childNodes, augments));
75 public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final ChoiceNode schema) {
76 super(String.format("Unknown child node: %s, not detected in choice: %s", child, schema));
79 public IllegalChildException(final YangInstanceIdentifier.PathArgument child, final DataSchemaNode schema, final Set<QName> childNodes) {
80 super(String.format("Unknown child node: %s, does not belong to: %s as a child. "
81 + "Child nodes: %s", child, schema, childNodes));
85 static final class IllegalListKeyException extends DataValidationException {
86 private static final long serialVersionUID = 1L;
88 public IllegalListKeyException(final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates id) {
89 super(String.format("Key value not present for key: %s, in: %s", keyQName, id));
92 public IllegalListKeyException(final QName keyQName, final YangInstanceIdentifier.NodeIdentifierWithPredicates id, final Object actualValue, final Object expectedValue) {
93 super(String.format("Illegal value for key: %s, in: %s, actual value: %s, expected value from key: %s", keyQName, id, actualValue, expectedValue));