model/ietf/rfc8519-ietf-ethertypes/src/main/java/org/opendaylight/yang/gen/v1/urn/ietf/params/xml/ns/yang/ietf/ethertypes/rev190304/EthertypeBuilder.java

   1 /*
   2  * Copyright (c) 2019 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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ethertypes.rev190304;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verify;
  12 import static com.google.common.base.Verify.verifyNotNull;
  13
  14 import com.google.common.base.CharMatcher;
  15 import java.util.Comparator;
  16 import java.util.EnumMap;
  17 import java.util.Objects;
  18 import java.util.Optional;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.yang.common.Uint16;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ethertypes.rev190304.Ethertype.Enumeration;
  22
  23 public final class EthertypeBuilder {
  24     private static final CharMatcher DIGITS = CharMatcher.inRange('0', '9');
  25     private static final EnumMap<Enumeration, Ethertype> ENUM_ETHERTYPES;
  26
  27     static {
  28         final EnumMap<Enumeration, Ethertype> map = new EnumMap<>(Enumeration.class);
  29         for (Enumeration value : Enumeration.values()) {
  30             verify(map.put(value, new Ethertype(value)) == null);
  31         }
  32         ENUM_ETHERTYPES = map;
  33     }
  34
  35     private EthertypeBuilder() {
  36         //Exists only to defeat instantiation.
  37     }
  38
  39     // TODO: the canonical representation is undefined. We may consider turning integers into enum values, but at this
  40     //       point it would confuse people and would not work well with JSON/XML parser output.
  41     public static @NonNull Ethertype getDefaultInstance(final String defaultValue) {
  42         final int length = defaultValue.length();
  43         if (length > 0 && length < 6 && DIGITS.matchesAllOf(defaultValue)) {
  44             final int value = Integer.parseInt(defaultValue);
  45             if (value < 65536) {
  46                 return new Ethertype(Uint16.valueOf(value));
  47             }
  48
  49             // Fall through and interpret as a string
  50         }
  51
  52         final Optional<Enumeration> known = Enumeration.forName(defaultValue);
  53         checkArgument(known.isPresent(), "Unknown ethertype %s", defaultValue);
  54         return verifyNotNull(ENUM_ETHERTYPES.get(known.get()));
  55     }
  56
  57     /**
  58      * Semantically compare two {@link Ethertype}s based on their numeric value, according to
  59      * {@link Comparator#compare(Object, Object)} contract.
  60      *
  61      * @param first First Ethertype
  62      * @param second Second Ethertype
  63      * @return a negative integer, zero, or a positive integer as the
  64      *         first argument is less than, equal to, or greater than the
  65      *         second.
  66      * @throws NullPointerException if any argument is null
  67      */
  68     public static int compareValue(final Ethertype first, final Ethertype second) {
  69         return Integer.compare(extractValue(first), extractValue(second));
  70     }
  71
  72     /**
  73      * Determine semantic equality of two {@link Ethertype}s based on their numeric value, according to
  74      * {@link Objects#equals(Object, Object)} contract. This is distinct from {@link Ethertype#equals(Object)}, which
  75      * does not perform semantic comparison.
  76      *
  77      * @param first First Ethertype
  78      * @param second Second Ethertype
  79      * @return True if the two Ethertypes are equal, false otherwise.
  80      */
  81     public static boolean equalValue(final Ethertype first, final Ethertype second) {
  82         return first == second || first != null && extractValue(first) == extractValue(second);
  83     }
  84
  85     /**
  86      * Determine semantic hash value of a {@link Ethertype}s based on its numeric value, according to
  87      * {@link Object#hashCode()} contract. This is distinct from {@link Ethertype#hashCode()}, which does not perform
  88      * semantic hashing. Unlike {@link Objects#hashCode(Object)}, this method does not return 0 for null objects.
  89      *
  90      * @param value Ethertype object
  91      * @return Specified object's semantic hashCode
  92      */
  93     public static int hashValue(final Ethertype value) {
  94         return value == null ? 65536 : extractValue(value);
  95     }
  96
  97     private static int extractValue(final Ethertype type) {
  98         final Enumeration known = type.getEnumeration();
  99         return known != null ? known.getIntValue() : verifyNotNull(type.getUint16()).intValue();
 100     }
 101 }