code-generator/binding-type-provider/src/main/java/org/opendaylight/yangtools/sal/binding/yang/types/BaseYangTypes.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.yangtools.sal.binding.yang.types;\r
   9 \r
  10 import java.math.BigDecimal;\r
  11 import java.math.BigInteger;\r
  12 import java.util.HashMap;\r
  13 import java.util.Map;\r
  14 \r
  15 import org.opendaylight.yangtools.binding.generator.util.Types;\r
  16 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;\r
  17 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;\r
  18 import org.opendaylight.yangtools.sal.binding.model.api.Type;\r
  19 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;\r
  20 import org.opendaylight.yangtools.yang.model.api.SchemaNode;\r
  21 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;\r
  22 \r
  23 public final class BaseYangTypes {\r
  24     /**\r
  25      * mapping of basic built-in YANG types (keys) to JAVA\r
  26      * {@link org.opendaylight.yangtools.sal.binding.model.api.Type Type}. This\r
  27      * map is filled with mapping data in static initialization block\r
  28      */\r
  29     private static Map<String, Type> typeMap = new HashMap<String, Type>();\r
  30 \r
  31     /**\r
  32      * <code>Type</code> representation of <code>boolean</code> YANG type\r
  33      */\r
  34     public static final Type BOOLEAN_TYPE = Types.typeForClass(Boolean.class);\r
  35 \r
  36     /**\r
  37      * <code>Type</code> representation of <code>empty</code> YANG type\r
  38      */\r
  39     public static final Type EMPTY_TYPE = Types.typeForClass(Boolean.class);\r
  40 \r
  41     /**\r
  42      * <code>Type</code> representation of <code>int8</code> YANG type\r
  43      */\r
  44     public static final Type INT8_TYPE = Types.typeForClass(Byte.class);\r
  45 \r
  46     /**\r
  47      * <code>Type</code> representation of <code>int16</code> YANG type\r
  48      */\r
  49     public static final Type INT16_TYPE = Types.typeForClass(Short.class);\r
  50 \r
  51     /**\r
  52      * <code>Type</code> representation of <code>int32</code> YANG type\r
  53      */\r
  54     public static final Type INT32_TYPE = Types.typeForClass(Integer.class);\r
  55 \r
  56     /**\r
  57      * <code>Type</code> representation of <code>int64</code> YANG type\r
  58      */\r
  59     public static final Type INT64_TYPE = Types.typeForClass(Long.class);\r
  60 \r
  61     /**\r
  62      * <code>Type</code> representation of <code>string</code> YANG type\r
  63      */\r
  64     public static final Type STRING_TYPE = Types.typeForClass(String.class);\r
  65 \r
  66     /**\r
  67      * <code>Type</code> representation of <code>decimal64</code> YANG type\r
  68      */\r
  69     public static final Type DECIMAL64_TYPE = Types.typeForClass(BigDecimal.class);\r
  70 \r
  71     /**\r
  72      * <code>Type</code> representation of <code>uint8</code> YANG type\r
  73      */\r
  74     public static final Type UINT8_TYPE = Types.typeForClass(Short.class);\r
  75 \r
  76     /**\r
  77      * <code>Type</code> representation of <code>uint16</code> YANG type\r
  78      */\r
  79     public static final Type UINT16_TYPE = Types.typeForClass(Integer.class);\r
  80 \r
  81     /**\r
  82      * <code>Type</code> representation of <code>uint32</code> YANG type\r
  83      */\r
  84     public static final Type UINT32_TYPE = Types.typeForClass(Long.class);\r
  85 \r
  86     /**\r
  87      * <code>Type</code> representation of <code>uint64</code> YANG type\r
  88      */\r
  89     public static final Type UINT64_TYPE = Types.typeForClass(BigInteger.class);\r
  90 \r
  91     /**\r
  92      * <code>Type</code> representation of <code>binary</code> YANG type\r
  93      */\r
  94     public static final Type BINARY_TYPE = Types.primitiveType("byte[]", null);\r
  95 \r
  96     public static final Type INSTANCE_IDENTIFIER = Types.parameterizedTypeFor(Types\r
  97             .typeForClass(InstanceIdentifier.class));\r
  98 \r
  99     /**\r
 100      * It is undesirable to create instance of this class.\r
 101      */\r
 102     private BaseYangTypes() {\r
 103 \r
 104     }\r
 105 \r
 106     static {\r
 107         typeMap.put("boolean", BOOLEAN_TYPE);\r
 108         typeMap.put("empty", EMPTY_TYPE);\r
 109         typeMap.put("int8", INT8_TYPE);\r
 110         typeMap.put("int16", INT16_TYPE);\r
 111         typeMap.put("int32", INT32_TYPE);\r
 112         typeMap.put("int64", INT64_TYPE);\r
 113         typeMap.put("string", STRING_TYPE);\r
 114         typeMap.put("decimal64", DECIMAL64_TYPE);\r
 115         typeMap.put("uint8", UINT8_TYPE);\r
 116         typeMap.put("uint16", UINT16_TYPE);\r
 117         typeMap.put("uint32", UINT32_TYPE);\r
 118         typeMap.put("uint64", UINT64_TYPE);\r
 119         typeMap.put("binary", BINARY_TYPE);\r
 120         typeMap.put("instance-identifier", INSTANCE_IDENTIFIER );\r
 121     }\r
 122 \r
 123     public static final TypeProvider BASE_YANG_TYPES_PROVIDER = new TypeProvider() {\r
 124         /**\r
 125          * Searches <code>Type</code> value to which is YANG <code>type</code>\r
 126          * mapped.\r
 127          *\r
 128          * @param type\r
 129          *            string with YANG type name\r
 130          * @return java <code>Type</code> representation of <code>type</code>\r
 131          */\r
 132         @Override\r
 133         public Type javaTypeForYangType(String type) {\r
 134             return typeMap.get(type);\r
 135         }\r
 136 \r
 137         /**\r
 138          * Searches <code>Type</code> value to which is YANG <code>type</code>\r
 139          * mapped.\r
 140          *\r
 141          * @param type\r
 142          *            type definition representation of YANG type\r
 143          * @return java <code>Type</code> representation of <code>type</code>.\r
 144          *         If <code>type</code> isn't found then <code>null</code> is\r
 145          *         returned.\r
 146          */\r
 147         @Override\r
 148         public Type javaTypeForSchemaDefinitionType(TypeDefinition<?> type, SchemaNode parentNode) {\r
 149             if (type != null) {\r
 150                 return typeMap.get(type.getQName().getLocalName());\r
 151             }\r
 152 \r
 153             return null;\r
 154         }\r
 155 \r
 156         @Override\r
 157         public Type javaTypeForSchemaDefinitionType(TypeDefinition<?> type, SchemaNode parentNode, Restrictions restrictions) {\r
 158             String typeName = type.getQName().getLocalName();\r
 159             switch (typeName) {\r
 160             case "binary" : return Types.primitiveType("byte[]", restrictions);\r
 161             case "decimal64": return Types.typeForClass(BigDecimal.class, restrictions);\r
 162             case "int8": return Types.typeForClass(Byte.class, restrictions);\r
 163             case "int16": return Types.typeForClass(Short.class, restrictions);\r
 164             case "int32": return Types.typeForClass(Integer.class, restrictions);\r
 165             case "int64": return Types.typeForClass(Long.class, restrictions);\r
 166             case "string": return Types.typeForClass(String.class, restrictions);\r
 167             case "uint8": return Types.typeForClass(Short.class, restrictions);\r
 168             case "uint16": Types.typeForClass(Integer.class, restrictions);\r
 169             case "uint32": Types.typeForClass(Long.class, restrictions);\r
 170             case "uint64": Types.typeForClass(BigInteger.class, restrictions);\r
 171             default: return javaTypeForSchemaDefinitionType(type, parentNode);\r
 172             }\r
 173         }\r
 174     };\r
 175 }\r