yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/type/StringEffectiveStatementImpl.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
   9 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type;
  10
  11 import com.google.common.base.Optional;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Objects;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.YangConstants;
  17 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  18 import org.opendaylight.yangtools.yang.model.api.Status;
  19 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement;
  22 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  23 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  24 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  26 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.TypeUtils;
  27 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase;
  28
  29 public class StringEffectiveStatementImpl extends EffectiveStatementBase<String, TypeStatement> implements
  30         StringTypeDefinition {
  31
  32     public static final String LOCAL_NAME = TypeUtils.STRING;
  33     private static final QName QNAME = QName.create(YangConstants.RFC6020_YANG_MODULE, LOCAL_NAME);
  34     private static final SchemaPath PATH = SchemaPath.create(true, QNAME);
  35     private static final String DEFAULT_VALUE = "";
  36     private static final String DESCRIPTION = "The string built-in type represents human-readable strings in YANG. "
  37             + "Legal characters are tab, carriage return, line feed, and the legal "
  38             + "characters of Unicode and ISO/IEC 10646";
  39     private static final String REFERENCE = "https://tools.ietf.org/html/rfc6020#section-9.4";
  40     private static final String UNITS = "";
  41     private static final Optional<String> OPTIONAL_EMPTY = Optional.of("");
  42
  43     private final List<LengthConstraint> lengthConstraints;
  44     private final List<PatternConstraint> patternConstraints;
  45
  46     public StringEffectiveStatementImpl(
  47             final StmtContext<String, TypeStatement, EffectiveStatement<String, TypeStatement>> ctx) {
  48         super(ctx);
  49
  50         final LengthConstraint defLength = new LengthConstraintEffectiveImpl(0, Integer.MAX_VALUE, OPTIONAL_EMPTY,
  51             OPTIONAL_EMPTY);
  52
  53         lengthConstraints = Collections.singletonList(defLength);
  54         patternConstraints = Collections.emptyList();
  55     }
  56
  57     @Override
  58     public List<LengthConstraint> getLengthConstraints() {
  59         return lengthConstraints;
  60     }
  61
  62     @Override
  63     public List<PatternConstraint> getPatternConstraints() {
  64         return patternConstraints;
  65     }
  66
  67     @Override
  68     public StringTypeDefinition getBaseType() {
  69         return null;
  70     }
  71
  72     @Override
  73     public String getUnits() {
  74         return UNITS;
  75     }
  76
  77     @Override
  78     public Object getDefaultValue() {
  79         return DEFAULT_VALUE;
  80     }
  81
  82     @Override
  83     public QName getQName() {
  84         return QNAME;
  85     }
  86
  87     @Override
  88     public SchemaPath getPath() {
  89         return PATH;
  90     }
  91
  92     @Override
  93     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
  94         return Collections.emptyList();
  95     }
  96
  97     @Override
  98     public String getDescription() {
  99         return DESCRIPTION;
 100     }
 101
 102     @Override
 103     public String getReference() {
 104         return REFERENCE;
 105     }
 106
 107     @Override
 108     public Status getStatus() {
 109         return Status.CURRENT;
 110     }
 111
 112     @Override
 113     public int hashCode() {
 114         final int prime = 31;
 115         int result = 1;
 116         result = prime * result + Objects.hashCode(lengthConstraints);
 117         result = prime * result + QNAME.hashCode();
 118         result = prime * result + PATH.hashCode();
 119         result = prime * result + Objects.hashCode(patternConstraints);
 120         return result;
 121     }
 122
 123     @Override
 124     public boolean equals(final Object obj) {
 125         if (this == obj) {
 126             return true;
 127         }
 128         if (obj == null) {
 129             return false;
 130         }
 131         if (getClass() != obj.getClass()) {
 132             return false;
 133         }
 134         StringEffectiveStatementImpl other = (StringEffectiveStatementImpl) obj;
 135         if (!Objects.equals(lengthConstraints, other.lengthConstraints)) {
 136             return false;
 137         }
 138         if (!Objects.equals(patternConstraints, other.patternConstraints)) {
 139             return false;
 140         }
 141         return true;
 142     }
 143
 144     @Override
 145     public String toString() {
 146         StringBuilder builder = new StringBuilder();
 147         builder.append(getClass().getSimpleName());
 148         builder.append(" [name=");
 149         builder.append(QNAME);
 150         builder.append(", path=");
 151         builder.append(PATH);
 152         builder.append(", defaultValue=");
 153         builder.append(DEFAULT_VALUE);
 154         builder.append(", description=");
 155         builder.append(DESCRIPTION);
 156         builder.append(", reference=");
 157         builder.append(REFERENCE);
 158         builder.append(", lengthStatements=");
 159         builder.append(lengthConstraints);
 160         builder.append(", patterns=");
 161         builder.append(patternConstraints);
 162         builder.append(", units=");
 163         builder.append(UNITS);
 164         builder.append("]");
 165         return builder.toString();
 166     }
 167 }