opendaylight/adsal/containermanager/implementation/src/main/java/org/opendaylight/controller/containermanager/internal/IContainerInternal.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.containermanager.internal;
  11
  12 import org.opendaylight.controller.containermanager.ContainerData;
  13
  14 /**
  15  * @file   IContainerInternal.java
  16  *
  17  * @brief  Interface to export internal container manager data to friend classes
  18  *
  19  * Interface to export internal container manager data to friend classes
  20  */
  21
  22 interface IContainerInternal {
  23     /**
  24      * Return a reference to containerData if available so a friend class
  25      * can extract all the data and cook them up.
  26      *
  27      * @param containerName ContainerName for which we want to export the data
  28      *
  29      * @return null if containerName doesn't exist or a reference to
  30      * ContainerData if exists
  31      */
  32     ContainerData getContainerData(String containerName);
  33 }