Fix javadocs and enable doclint
[controller.git] / opendaylight / md-sal / sal-clustering-commons / src / main / java / org / opendaylight / controller / cluster / common / actor / UnifiedConfig.java
1 /*
2  * Copyright (c) 2014 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.cluster.common.actor;
9
10 import com.typesafe.config.Config;
11
12 /**
13  * Represents a unified view of configuration.
14  *
15  * <p>
16  * It merges configuration from:
17  * <ul>
18  *     <li>Config subsystem</li>
19  *     <li>Akka configuration files</li>
20  * </ul>
21  * Configurations defined in config subsystem takes precedence.
22  */
23 public interface UnifiedConfig {
24
25     /**
26      * Returns an immutable instance of unified configuration.
27      *
28      * @return a Config instance
29      */
30     Config get();
31 }