common/concepts/src/main/java/org/opendaylight/yangtools/concepts/AbstractIllegalArgumentCodec.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.yangtools.concepts;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.jdt.annotation.Nullable;
  16
  17 /**
  18  * An abstract base class enforcing nullness contract around {@link IllegalArgumentCodec} interface.
  19  *
  20  * @param <S> Serializied (external) type
  21  * @param <D> Deserialized (internal) type
  22  * @deprecated This is a base class for implementing IllegalArgumentCodec, without further use. It will be removed with
  23  *             IllegalArgumentCodec.
  24  */
  25 @Beta
  26 @Deprecated(since = "8.0.0", forRemoval = true)
  27 public abstract class AbstractIllegalArgumentCodec<S, D> implements IllegalArgumentCodec<S, D> {
  28     @Override
  29     public final D deserialize(final S input) {
  30         return verifyResult(deserializeImpl(requireNonNull(input)), input);
  31     }
  32
  33     @Override
  34     public final S serialize(final D input) {
  35         return verifyResult(serializeImpl(requireNonNull(input)), input);
  36     }
  37
  38     // implementation is guarded from nulls and verified not to return null
  39     protected abstract @NonNull D deserializeImpl(@NonNull S product);
  40
  41     // implementation is guarded from nulls and verified not to return null
  42     protected abstract @NonNull S serializeImpl(@NonNull D input);
  43
  44     private <X> X verifyResult(final @Nullable X result, final Object input) {
  45         return verifyNotNull(result, "Codec %s returned null on %s", this, input);
  46     }
  47 }