restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/DatabindPathFormattableBody.java

   1 /*
   2  * Copyright (c) 2024 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.restconf.server.api;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects.ToStringHelper;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.jdt.annotation.NonNullByDefault;
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.opendaylight.restconf.api.FormattableBody;
  17
  18 /**
  19  * A {@link FormattableBody} which has an attached {@link DatabindPath}.
  20  */
  21 @NonNullByDefault
  22 public abstract class DatabindPathFormattableBody<P extends DatabindPath> extends FormattableBody {
  23     private final @NonNull P path;
  24
  25     protected DatabindPathFormattableBody(final P path) {
  26         this.path = requireNonNull(path);
  27     }
  28
  29     public final P path() {
  30         return path;
  31     }
  32
  33     @Override
  34     protected ToStringHelper addToStringAttributes(final ToStringHelper helper) {
  35         return helper.add("path", path).add("body", bodyAttribute());
  36     }
  37
  38     protected abstract @Nullable Object bodyAttribute();
  39 }