yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/MinMaxElementsValidation.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
   9
  10 import com.google.common.base.MoreObjects.ToStringHelper;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.eclipse.jdt.annotation.NonNullByDefault;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  16 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.tree.RequiredElementCountException;
  18 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  20 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraintAware;
  21
  22 final class MinMaxElementsValidation<T extends DataSchemaNode & ElementCountConstraintAware>
  23         extends AbstractValidation {
  24     private final int minElements;
  25     private final int maxElements;
  26
  27     private MinMaxElementsValidation(final SchemaAwareApplyOperation<T> delegate, final Integer minElements,
  28             final Integer maxElements) {
  29         super(delegate);
  30         this.minElements = minElements != null ? minElements : 0;
  31         this.maxElements = maxElements != null ? maxElements : Integer.MAX_VALUE;
  32     }
  33
  34     static <T extends DataSchemaNode & ElementCountConstraintAware> ModificationApplyOperation from(
  35             final SchemaAwareApplyOperation<T> delegate) {
  36         final Optional<ElementCountConstraint> optConstraint = delegate.getSchema().getElementCountConstraint();
  37         if (!optConstraint.isPresent()) {
  38             return delegate;
  39         }
  40
  41         final ElementCountConstraint constraint = optConstraint.get();
  42         return new MinMaxElementsValidation<>(delegate, constraint.getMinElements(), constraint.getMaxElements());
  43     }
  44
  45     @Override
  46     void enforceOnData(final NormalizedNode<?, ?> data) {
  47         enforceOnData(data, (actual, message) -> new MinMaxElementsValidationFailedException(message));
  48     }
  49
  50     @Override
  51     void enforceOnData(final ModificationPath path, final NormalizedNode<?, ?> data)
  52             throws RequiredElementCountException {
  53         enforceOnData(data, (actual, message) -> new RequiredElementCountException(path.toInstanceIdentifier(),
  54             minElements, maxElements, actual, message));
  55     }
  56
  57     @FunctionalInterface
  58     @NonNullByDefault
  59     interface ExceptionSupplier<T extends Exception> {
  60         T get(int actual, String message);
  61     }
  62
  63     private <X extends @NonNull Exception> void enforceOnData(final NormalizedNode<?, ?> value,
  64             final ExceptionSupplier<X> exceptionSupplier) throws X {
  65         final int children = numOfChildrenFromValue(value);
  66         if (minElements > children) {
  67             throw exceptionSupplier.get(children, value.getIdentifier()
  68                 + " does not have enough elements (" + children + "), needs at least " + minElements);
  69         }
  70         if (maxElements < children) {
  71             throw exceptionSupplier.get(children, value.getIdentifier()
  72                 + " has too many elements (" + children + "), can have at most " + maxElements);
  73         }
  74     }
  75
  76     @Override
  77     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  78         return super.addToStringAttributes(helper.add("min", minElements).add("max", maxElements));
  79     }
  80
  81     private static int numOfChildrenFromValue(final NormalizedNode<?, ?> value) {
  82         if (value instanceof NormalizedNodeContainer) {
  83             return ((NormalizedNodeContainer<?, ?, ?>) value).size();
  84         } else if (value instanceof UnkeyedListNode) {
  85             return ((UnkeyedListNode) value).getSize();
  86         }
  87
  88         throw new IllegalArgumentException(String.format(
  89                 "Unexpected type '%s', expected types are NormalizedNodeContainer and UnkeyedListNode",
  90                 value.getClass()));
  91     }
  92 }