opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java

   1 /*
   2  * Copyright (c) 2015 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.md.sal.dom.api;
   9
  10 import java.util.Collection;
  11 import javax.annotation.Nonnull;
  12
  13 /**
  14  * Base source of {@link DOMDataTreeProducer}s. This interface is usually not used directly,
  15  * but rather through one of its sub-interfaces.
  16  */
  17 public interface DOMDataTreeProducerFactory {
  18     /**
  19      * Create a producer, which is able to access to a set of trees.
  20      *
  21      * @param subtrees The collection of subtrees the resulting producer should have access to.
  22      * @return A {@link DOMDataTreeProducer} instance.
  23      * @throws {@link IllegalArgumentException} if subtrees is empty.
  24      */
  25     @Nonnull DOMDataTreeProducer createProducer(@Nonnull Collection<DOMDataTreeIdentifier> subtrees);
  26 }