gerrit.onap Code Review - dcaegen2/services/sdk.git/blob

   1 /*
   2  * ============LICENSE_START====================================
   3  * DCAEGEN2-SERVICES-SDK
   4  * =========================================================
   5  * Copyright (C) 2019 Nokia. All rights reserved.
   6  * =========================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *       http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=====================================
  19  */
  20
  21 package org.onap.dcaegen2.services.sdk.rest.services.cbs.client.api.listener;
  22
  23 import io.vavr.collection.List;
  24 import io.vavr.control.Option;
  25 import java.util.function.Consumer;
  26
  27 /**
  28  * The listener for changes of the {@link MerkleTree} subtree.
  29  *
  30  * @author <a href="mailto:piotr.jaszczyk@nokia.com">Piotr Jaszczyk</a>
  31  * @since 1.1.2
  32  */
  33 @FunctionalInterface
  34 public interface TreeChangeListener<V> extends Consumer<Option<MerkleTree<V>>> {
  35
  36     /**
  37      * Will be called when a change in a subtree has been detected. Default implementation will extract the changed subtree
  38      * from the root and call {@link #accept(Option)}.
  39      *
  40      * @param updatedTree new, updated root tree
  41      * @param path a changed path
  42      */
  43     default void accept(MerkleTree<V> updatedTree, List<String> path) {
  44         accept(updatedTree.subtree(path));
  45     }
  46
  47     /**
  48      * Will be called when a change in a subtree has been detected.
  49      *
  50      * @param updatedSubtree new, updated subtree or None when branch has been removed
  51      */
  52     @Override
  53     void accept(Option<MerkleTree<V>> updatedSubtree);
  54 }