dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/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.mdsal.dom.api;
   9
  10 import java.util.Collection;
  11 import org.eclipse.jdt.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  * @deprecated This interface is scheduled for removal in the next major release.
  18  */
  19 @Deprecated(forRemoval = true)
  20 public interface DOMDataTreeProducerFactory {
  21     /**
  22      * Create a producer, which is able to access to a set of trees.
  23      *
  24      * @param subtrees The collection of subtrees the resulting producer should have access to.
  25      * @return A {@link DOMDataTreeProducer} instance.
  26      * @throws IllegalArgumentException if subtrees is empty.
  27      */
  28     @NonNull DOMDataTreeProducer createProducer(@NonNull Collection<DOMDataTreeIdentifier> subtrees);
  29 }