Add MountInstance client documentation and promote to ListenableFuture
[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / sal / core / api / mount / MountService.java
1 /*
2  * Copyright (c) 2013 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.sal.core.api.mount;
9
10 import org.opendaylight.controller.sal.core.api.BrokerService;
11 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
12
13 /**
14  * Client-level interface for interacting with mount points. It provides access
15  * to {@link MountInstance} instances based on their path.
16  */
17 public interface MountService extends BrokerService {
18     /**
19      * Obtain access to a mount instance registered at the specified path.
20      *
21      * @param path Path at which the instance is registered
22      * @return Reference to the instance, or null if no such instance exists.
23      */
24     MountInstance getMountPoint(InstanceIdentifier path);
25 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.