gerrit.fd Code Review - hc2vpp.git/blob

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.v3po.translate.spi.write;
  18
  19 import com.google.common.annotations.Beta;
  20 import com.google.common.base.Optional;
  21 import javax.annotation.Nonnull;
  22 import org.opendaylight.yangtools.yang.binding.DataObject;
  23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  24
  25 /**
  26  * CompositeChildWriter SPI to customize its behavior
  27  *
  28  * @param <D> Specific DataObject derived type (Identifiable), that is handled by this customizer
  29  */
  30 @Beta
  31 public interface ChildWriterCustomizer<D extends DataObject> extends RootWriterCustomizer<D> {
  32
  33     /**
  34      * Get child of parentData identified by currentId
  35      *
  36      * @param currentId Identifier(from root) of data being extracted
  37      * @param parentData Parent data object from which managed data object must be extracted
  38      */
  39     @Nonnull
  40     Optional<D> extract(@Nonnull final InstanceIdentifier<D> currentId, @Nonnull final DataObject parentData);
  41
  42 }