yang/yang-model-ri/src/main/java/org/opendaylight/yangtools/yang/model/ri/type/StringTypeBuilder.java

   1 /*
   2  * Copyright (c) 2015 Pantheon Technologies s.r.o. 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.model.ri.type;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  17 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  18 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  19
  20 public final class StringTypeBuilder extends LengthRestrictedTypeBuilder<StringTypeDefinition> {
  21     private final List<PatternConstraint> patternConstraints = new ArrayList<>(0);
  22
  23     StringTypeBuilder(final StringTypeDefinition baseType, final QName qname) {
  24         super(baseType, qname);
  25     }
  26
  27     public StringTypeBuilder addPatternConstraint(final PatternConstraint constraint) {
  28         patternConstraints.add(requireNonNull(constraint));
  29         touch();
  30         return this;
  31     }
  32
  33     @Override
  34     LengthConstraint typeLengthConstraints() {
  35         /**
  36          * Length constraint imposed on YANG string type by our implementation. {@link String#length()} is an integer,
  37          * capping our ability to support strings up to 18446744073709551615 as defined in
  38          * http://tools.ietf.org/html/rfc6020#section-9.4.4.
  39          *
  40          * FIXME: We could bump this number up to allow such models, but that could lead to unexpected run-time errors.
  41          *        In order to do that, the parser would need another pass on the effective statements, which would cap
  42          *        the constraints to the run-time environment.
  43          */
  44         return JavaLengthConstraints.INTEGER_SIZE_CONSTRAINTS;
  45     }
  46
  47     @Override
  48     StringTypeDefinition buildType(final @Nullable LengthConstraint constraint) {
  49         return new RestrictedStringType(getBaseType(), getQName(), getUnknownSchemaNodes(), constraint,
  50             patternConstraints);
  51     }
  52 }