opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/ReadTransactionSuccess.java

   1 /*
   2  * Copyright (c) 2016 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 package org.opendaylight.controller.cluster.access.commands;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.util.Optional;
  14 import org.opendaylight.controller.cluster.access.ABIVersion;
  15 import org.opendaylight.controller.cluster.access.concepts.SliceableMessage;
  16 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  18
  19 /**
  20  * Successful reply to an {@link ReadTransactionRequest}. It indicates presence of requested data via
  21  * {@link #getData()}.
  22  */
  23 public final class ReadTransactionSuccess extends TransactionSuccess<ReadTransactionSuccess>
  24         implements SliceableMessage {
  25     @java.io.Serial
  26     private static final long serialVersionUID = 1L;
  27
  28     @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "interface-based best effort")
  29     private final Optional<NormalizedNode> data;
  30
  31     private ReadTransactionSuccess(final ReadTransactionSuccess request, final ABIVersion version) {
  32         super(request, version);
  33         data = request.data;
  34     }
  35
  36     public ReadTransactionSuccess(final TransactionIdentifier identifier, final long sequence,
  37             final Optional<NormalizedNode> data) {
  38         super(identifier, sequence);
  39         this.data = requireNonNull(data);
  40     }
  41
  42     public Optional<NormalizedNode> getData() {
  43         return data;
  44     }
  45
  46     @Override
  47     protected RTS externalizableProxy(final ABIVersion version) {
  48         return new RTS(this);
  49     }
  50
  51     @Override
  52     protected ReadTransactionSuccess cloneAsVersion(final ABIVersion version) {
  53         return new ReadTransactionSuccess(this, version);
  54     }
  55 }