binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/mdsal/binding/model/api/Type.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  * The Type interface defines the base type for all types defined in java. Each
  12  * Type defined in java MUST contain name and package name, except of primitive
  13  * types like int, byte etc. In case of mapping of primitive type the package
  14  * name MUST be left as empty string.
  15  */
  16 public interface Type {
  17     /**
  18      * Returns name of the package that interface belongs to.
  19      *
  20      * @return name of the package that interface belongs to
  21      */
  22     String getPackageName();
  23
  24     /**
  25      * Returns name of the interface.
  26      *
  27      * @return name of the interface.
  28      */
  29     String getName();
  30
  31     /**
  32      * Returns fully qualified name of Type. <br>
  33      * The fully qualified name of Type MUST be returned in following format:
  34      * <ul>
  35      * <li>If does not contains package name: [type name] (e.g. int, byte,
  36      * byte[],...)</li>
  37      * <li>If Type contains package name: [package name].[type name] (e.g
  38      * java.lang.Byte, org.opendaylight.controller.gen.GenType)</li>
  39      * </ul>
  40      *
  41      * @return fully qualified name of Type.
  42      */
  43     String getFullyQualifiedName();
  44 }