dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/shard/WriteableDOMDataTreeShard.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
   9 package org.opendaylight.mdsal.dom.spi.shard;
  10
  11 import com.google.common.annotations.Beta;
  12 import java.util.Collection;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  14 import org.opendaylight.mdsal.dom.api.DOMDataTreeShard;
  15
  16 /**
  17  * Indicates that a shard is writable via the provided {@link #createProducer(Collection) createProducer} method.
  18  */
  19 @Beta
  20 public interface WriteableDOMDataTreeShard extends DOMDataTreeShard {
  21
  22     /**
  23      * Create a producer that has the ability to write into the provided subtrees.
  24      * @param paths Subtrees that the caller wants to write into.
  25      * @return Producer.
  26      */
  27     DOMDataTreeShardProducer createProducer(Collection<DOMDataTreeIdentifier> paths);
  28 }