2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.sal.binding.yang.types;
10 import com.google.common.base.Optional;
11 import com.google.common.collect.ImmutableMap;
12 import com.google.common.collect.ImmutableMap.Builder;
13 import java.math.BigDecimal;
14 import java.math.BigInteger;
15 import java.util.Collections;
16 import java.util.List;
18 import org.opendaylight.yangtools.binding.generator.util.Types;
19 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
20 import org.opendaylight.yangtools.sal.binding.model.api.Restrictions;
21 import org.opendaylight.yangtools.sal.binding.model.api.Type;
22 import org.opendaylight.yangtools.yang.binding.BindingMapping;
23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
24 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
27 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
28 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
29 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
30 import org.opendaylight.yangtools.yang.model.util.BaseConstraints;
32 public final class BaseYangTypes {
34 * mapping of basic built-in YANG types (keys) to JAVA
35 * {@link org.opendaylight.yangtools.sal.binding.model.api.Type Type}. This
36 * map is filled with mapping data in static initialization block
38 private static final Map<String, Type> TYPE_MAP;
41 * <code>Type</code> representation of <code>boolean</code> YANG type
43 public static final Type BOOLEAN_TYPE = Types.typeForClass(Boolean.class);
46 * <code>Type</code> representation of <code>empty</code> YANG type
48 public static final Type EMPTY_TYPE = Types.typeForClass(Boolean.class);
50 public static final Type ENUM_TYPE = Types.typeForClass(Enum.class);
53 * <code>Type</code> representation of <code>int8</code> YANG type
55 public static final Type INT8_TYPE = Types.typeForClass(Byte.class);
58 * <code>Type</code> representation of <code>int16</code> YANG type
60 public static final Type INT16_TYPE = Types.typeForClass(Short.class);
63 * <code>Type</code> representation of <code>int32</code> YANG type
65 public static final Type INT32_TYPE = Types.typeForClass(Integer.class);
68 * <code>Type</code> representation of <code>int64</code> YANG type
70 public static final Type INT64_TYPE = Types.typeForClass(Long.class);
73 * <code>Type</code> representation of <code>string</code> YANG type
75 public static final Type STRING_TYPE = Types.typeForClass(String.class);
78 * <code>Type</code> representation of <code>decimal64</code> YANG type
80 public static final Type DECIMAL64_TYPE = Types.typeForClass(BigDecimal.class);
83 * <code>Type</code> representation of <code>uint8</code> YANG type
85 public static final Type UINT8_TYPE = Types.typeForClass(Short.class, singleRangeRestrictions((short)0, (short)255));
88 * <code>Type</code> representation of <code>uint16</code> YANG type
90 public static final Type UINT16_TYPE = Types.typeForClass(Integer.class, singleRangeRestrictions(0, 65535));
93 * <code>Type</code> representation of <code>uint32</code> YANG type
95 public static final Type UINT32_TYPE = Types.typeForClass(Long.class, singleRangeRestrictions(0L, 4294967295L));
98 * <code>Type</code> representation of <code>uint64</code> YANG type
100 public static final Type UINT64_TYPE = Types.typeForClass(BigInteger.class,
101 singleRangeRestrictions(BigInteger.ZERO, new BigInteger("18446744073709551615")));
103 public static final Type UNION_TYPE = new UnionType();
106 * <code>Type</code> representation of <code>binary</code> YANG type
108 public static final Type BINARY_TYPE = Types.primitiveType("byte[]", null);
110 public static final Type INSTANCE_IDENTIFIER = Types.parameterizedTypeFor(Types
111 .typeForClass(InstanceIdentifier.class));
114 * It is undesirable to create instance of this class.
116 private BaseYangTypes() {
117 throw new UnsupportedOperationException();
121 final Builder<String, Type> b = ImmutableMap.<String, Type>builder();
123 b.put("boolean", BOOLEAN_TYPE);
124 b.put("empty", EMPTY_TYPE);
125 b.put("enumeration", ENUM_TYPE);
126 b.put("int8", INT8_TYPE);
127 b.put("int16", INT16_TYPE);
128 b.put("int32", INT32_TYPE);
129 b.put("int64", INT64_TYPE);
130 b.put("string", STRING_TYPE);
131 b.put("decimal64", DECIMAL64_TYPE);
132 b.put("uint8", UINT8_TYPE);
133 b.put("uint16", UINT16_TYPE);
134 b.put("uint32", UINT32_TYPE);
135 b.put("uint64", UINT64_TYPE);
136 b.put("union", UNION_TYPE);
137 b.put("binary", BINARY_TYPE);
138 b.put("instance-identifier", INSTANCE_IDENTIFIER);
140 TYPE_MAP = b.build();
143 public static final TypeProvider BASE_YANG_TYPES_PROVIDER = new TypeProvider() {
145 * Searches <code>Type</code> value to which is YANG <code>type</code>
149 * string with YANG type name
150 * @return java <code>Type</code> representation of <code>type</code>
153 public Type javaTypeForYangType(final String type) {
154 return TYPE_MAP.get(type);
158 * Searches <code>Type</code> value to which is YANG <code>type</code>
162 * type definition representation of YANG type
163 * @return java <code>Type</code> representation of <code>type</code>.
164 * If <code>type</code> isn't found then <code>null</code> is
168 public Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> type, final SchemaNode parentNode) {
170 return TYPE_MAP.get(type.getQName().getLocalName());
177 public Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> type, final SchemaNode parentNode,
178 final Restrictions restrictions) {
179 String typeName = type.getQName().getLocalName();
182 return restrictions == null ? Types.BYTE_ARRAY : Types.primitiveType("byte[]", restrictions);
184 return Types.typeForClass(BigDecimal.class, restrictions);
186 return Types.typeForClass(Enum.class, restrictions);
188 return Types.typeForClass(Byte.class, restrictions);
190 return Types.typeForClass(Short.class, restrictions);
192 return Types.typeForClass(Integer.class, restrictions);
194 return Types.typeForClass(Long.class, restrictions);
196 return Types.typeForClass(String.class, restrictions);
198 return Types.typeForClass(Short.class, restrictions);
200 return Types.typeForClass(Integer.class, restrictions);
202 return Types.typeForClass(Long.class, restrictions);
204 return Types.typeForClass(BigInteger.class, restrictions);
208 return javaTypeForSchemaDefinitionType(type, parentNode);
213 public String getTypeDefaultConstruction(final LeafSchemaNode node) {
218 public String getConstructorPropertyName(final SchemaNode node) {
223 public String getParamNameFromType(final TypeDefinition<?> type) {
224 return "_" + BindingMapping.getPropertyName(type.getQName().getLocalName());
228 private static <T extends Number> Restrictions singleRangeRestrictions(final T min, final T max) {
229 return new Restrictions() {
231 public boolean isEmpty() {
236 public List<RangeConstraint> getRangeConstraints() {
237 return Collections.singletonList(BaseConstraints.newRangeConstraint(min, max,
238 Optional.<String> absent(), Optional.<String> absent()));
242 public List<PatternConstraint> getPatternConstraints() {
243 return Collections.emptyList();
247 public List<LengthConstraint> getLengthConstraints() {
248 return Collections.emptyList();
253 public static final class UnionType implements Type {
255 public String getPackageName() {
259 public String getName() {
263 public String getFullyQualifiedName() {