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