Do not generate 'isFoo()' methods
[mdsal.git] / dom / mdsal-dom-spi / src / main / java / org / opendaylight / mdsal / dom / spi / shard / DOMDataTreeShardProducer.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 package org.opendaylight.mdsal.dom.spi.shard;
9
10 import com.google.common.annotations.Beta;
11 import java.util.Collection;
12 import org.eclipse.jdt.annotation.NonNull;
13 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
14 import org.opendaylight.yangtools.concepts.Registration;
15
16 @Beta
17 @Deprecated(forRemoval = true)
18 public interface DOMDataTreeShardProducer extends Registration {
19     /**
20      * Return the collection of tree identifiers to which this producer is bound. This collection
21      * is constant during the lifetime of a producer.
22      *
23      * @return Collection of data tree identifiers.
24      */
25     @NonNull Collection<DOMDataTreeIdentifier> getPrefixes();
26
27     /**
28      * Create a new write transaction for this producer. Any previous transactions need to be closed either via
29      * {@link DOMDataTreeShardWriteTransaction#ready()} or cancelled.
30      *
31      * @return A new write transaction
32      * @throws IllegalStateException if a previous transaction has not been closed
33      */
34     @NonNull DOMDataTreeShardWriteTransaction createTransaction();
35
36     /**
37      * Close this producer, releasing all resources.
38      */
39     @Override
40     void close();
41 }