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