yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/pattern/AbstractPatternConstraint.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, 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.parser.rfc7950.stmt.pattern;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import java.util.Objects;
  15 import java.util.Optional;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.opendaylight.yangtools.concepts.Immutable;
  18 import org.opendaylight.yangtools.yang.model.api.type.ModifierKind;
  19 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  20
  21 abstract class AbstractPatternConstraint implements PatternConstraint, Immutable {
  22     private final String regEx;
  23     private final String rawRegEx;
  24     private final String errorAppTag;
  25
  26     AbstractPatternConstraint(final String regex, final String rawRegex, final String errorAppTag) {
  27         this.regEx = requireNonNull(regex, "regex must not be null");
  28         this.rawRegEx = requireNonNull(rawRegex, "raw regex must not be null");
  29         // FIXME: 6.0.0: explain this assignment
  30         this.errorAppTag = errorAppTag != null ? errorAppTag : "invalid-regular-expression";
  31     }
  32
  33     @Override
  34     public final String getJavaPatternString() {
  35         return regEx;
  36     }
  37
  38     @Override
  39     public final String getRegularExpressionString() {
  40         return rawRegEx;
  41     }
  42
  43     @Override
  44     public final Optional<String> getDescription() {
  45         return Optional.ofNullable(description());
  46     }
  47
  48     @Override
  49     public final Optional<String> getErrorAppTag() {
  50         return Optional.of(errorAppTag);
  51     }
  52
  53     @Override
  54     public final Optional<String> getErrorMessage() {
  55         return Optional.ofNullable(errorMessage());
  56     }
  57
  58     @Override
  59     public final Optional<ModifierKind> getModifier() {
  60         return Optional.ofNullable(modifier());
  61     }
  62
  63     @Override
  64     public final Optional<String> getReference() {
  65         return Optional.ofNullable(reference());
  66     }
  67
  68     @Override
  69     public final int hashCode() {
  70         return Objects.hash(description(), errorAppTag, errorMessage(), reference(), regEx, modifier());
  71     }
  72
  73     @Override
  74     public final boolean equals(final Object obj) {
  75         if (this == obj) {
  76             return true;
  77         }
  78         if (!(obj instanceof AbstractPatternConstraint)) {
  79             return false;
  80         }
  81         final AbstractPatternConstraint other = (AbstractPatternConstraint) obj;
  82         return Objects.equals(description(), other.description()) && Objects.equals(errorAppTag, other.errorAppTag)
  83                 && Objects.equals(errorMessage(), other.errorMessage())
  84                 && Objects.equals(reference(), other.reference()) && Objects.equals(regEx, other.regEx)
  85                 && Objects.equals(modifier(), other.modifier());
  86     }
  87
  88     @Override
  89     public final String toString() {
  90         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
  91     }
  92
  93     abstract @Nullable String description();
  94
  95     abstract @Nullable String reference();
  96
  97     abstract @Nullable String errorMessage();
  98
  99     abstract @Nullable ModifierKind modifier();
 100
 101     ToStringHelper addToStringAttributes(final ToStringHelper helper) {
 102         return helper.add("regex", regEx).add("errorAppTag", errorAppTag);
 103     }
 104 }