code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/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.yangtools.sal.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  */
  17 public interface Type {
  18     /**
  19      * Returns name of the package that interface belongs to.
  20      *
  21      * @return name of the package that interface belongs to
  22      */
  23     String getPackageName();
  24
  25     /**
  26      * Returns name of the interface.
  27      *
  28      * @return name of the interface.
  29      */
  30     String getName();
  31
  32     /**
  33      * Returns fully qualified name of Type. <br>
  34      * The fully qualified name of Type MUST be returned in following format:
  35      * <ul>
  36      * <li>If does not contains package name: [type name] (e.g. int, byte,
  37      * byte[],...)</li>
  38      * <li>If Type contains package name: [package name].[type name] (e.g
  39      * java.lang.Byte, org.opendaylight.controller.gen.GenType)</li>
  40      * </ul>
  41      *
  42      * @return fully qualified name of Type.
  43      */
  44     String getFullyQualifiedName();
  45 }