binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/ParameterizedType.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.mdsal.binding.model.api;
   9
  10 /**
  11  * Represents an instance of simple parameterized type such as List&lt;String&gt;. The parameterized Type is designed
  12  * to be used to store information of Java  Generic Type. The array of {@link #getActualTypeArguments()} holds
  13  * information of all generic parameters defined for Parameterized Type.
  14  */
  15 public interface ParameterizedType extends Type {
  16     /**
  17      * Returns array of Types that are defined for Parameterized Type.
  18      * <br>
  19      * (for example if ParameterizedType encapsulates java generic Map that specifies two parameters Map&lt;K,V&gt;
  20      * and the K is java.lang.Integer and V is defined as GeneratedType the array will contain two Types to store
  21      * the information of generic parameters.)
  22      *
  23      * @return array of Types that are defined for Parameterized Type.
  24      */
  25     Type[] getActualTypeArguments();
  26
  27     /**
  28      * Returns the Raw Type definition of Parameterized Type.
  29      *
  30      * @return the Raw Type definition of Parameterized Type.
  31      */
  32     Type getRawType();
  33 }