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.mdsal.binding.model.util;
10 import com.google.common.base.CharMatcher;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Splitter;
14 import com.google.common.cache.CacheBuilder;
15 import com.google.common.cache.CacheLoader;
16 import com.google.common.cache.LoadingCache;
17 import com.google.common.collect.Iterables;
18 import java.util.Collections;
19 import java.util.List;
22 import java.util.concurrent.Future;
23 import javax.annotation.Nullable;
24 import org.opendaylight.mdsal.binding.model.api.BaseTypeWithRestrictions;
25 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
26 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
27 import org.opendaylight.mdsal.binding.model.api.Restrictions;
28 import org.opendaylight.mdsal.binding.model.api.Type;
29 import org.opendaylight.mdsal.binding.model.api.WildcardType;
30 import org.opendaylight.yangtools.yang.binding.Augmentable;
31 import org.opendaylight.yangtools.yang.binding.Augmentation;
32 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
33 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
34 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
35 import org.opendaylight.yangtools.yang.model.util.BaseConstraints;
37 public final class Types {
38 private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER =
39 new CacheLoader<Class<?>, ConcreteType>() {
41 public ConcreteType load(final Class<?> key) {
42 return new ConcreteTypeImpl(key.getPackage().getName(), key.getSimpleName(), null);
45 private static final LoadingCache<Class<?>, ConcreteType> TYPE_CACHE =
46 CacheBuilder.newBuilder().weakKeys().build(TYPE_LOADER);
48 private static final Type SET_TYPE = typeForClass(Set.class);
49 private static final Type LIST_TYPE = typeForClass(List.class);
50 private static final Type MAP_TYPE = typeForClass(Map.class);
52 public static final ConcreteType BOOLEAN = typeForClass(Boolean.class);
53 public static final ConcreteType FUTURE = typeForClass(Future.class);
54 public static final ConcreteType STRING = typeForClass(String.class);
55 public static final ConcreteType VOID = typeForClass(Void.class);
56 public static final ConcreteType BYTE_ARRAY = primitiveType("byte[]", null);
57 public static final ConcreteType CHAR_ARRAY = primitiveType("char[]", null);
58 private static final Splitter DOT_SPLITTER = Splitter.on('.');
61 * It is not desirable to create instance of this class
67 * Creates the instance of type
68 * {@link org.opendaylight.mdsal.binding.model.api.ConcreteType
69 * ConcreteType} which represents JAVA <code>void</code> type.
71 * @return <code>ConcreteType</code> instance which represents JAVA
74 public static ConcreteType voidType() {
79 * Creates the instance of type
80 * {@link org.opendaylight.mdsal.binding.model.api.ConcreteType
81 * ConcreteType} which represents primitive JAVA type for which package
84 * @param primitiveType
85 * string containing programmatic construction based on
86 * primitive type (e.g byte[])
89 * @return <code>ConcreteType</code> instance which represents programmatic
90 * construction with primitive JAVA type
92 public static ConcreteType primitiveType(final String primitiveType, final Restrictions restrictions) {
93 return new ConcreteTypeImpl("", primitiveType, restrictions);
97 * Returns an instance of {@link ConcreteType} describing the class
101 * @return Description of class
103 public static ConcreteType typeForClass(final Class<?> cls) {
104 return TYPE_CACHE.getUnchecked(cls);
107 public static ConcreteType typeForClass(final Class<?> cls, final Restrictions restrictions) {
108 if (restrictions == null) {
109 return typeForClass(cls);
111 if (restrictions instanceof DefaultRestrictions) {
112 return new ConcreteTypeImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
114 return new BaseTypeWithRestrictionsImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
118 * Returns an instance of {@link ParameterizedType} describing the typed
119 * {@link Map}<K,V>
125 * @return Description of generic type instance
127 public static ParameterizedType mapTypeFor(final Type keyType, final Type valueType) {
128 return parameterizedTypeFor(MAP_TYPE, keyType, valueType);
132 * Returns an instance of {@link ParameterizedType} describing the typed
133 * {@link Set}<V> with concrete type of value.
137 * @return Description of generic type instance of Set
139 public static ParameterizedType setTypeFor(final Type valueType) {
140 return parameterizedTypeFor(SET_TYPE, valueType);
144 * Returns an instance of {@link ParameterizedType} describing the typed
145 * {@link List}<V> with concrete type of value.
149 * @return Description of type instance of List
151 public static ParameterizedType listTypeFor(final Type valueType) {
152 return parameterizedTypeFor(LIST_TYPE, valueType);
156 * Creates instance of type
157 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
161 * JAVA <code>Type</code> for raw type
163 * JAVA <code>Type</code>s for actual parameter types
164 * @return <code>ParametrizedType</code> reprezentation of <code>type</code>
165 * and its parameters <code>parameters</code>
167 public static ParameterizedType parameterizedTypeFor(final Type type, final Type... parameters) {
168 return new ParametrizedTypeImpl(type, parameters);
172 * Creates instance of type
173 * {@link org.opendaylight.mdsal.binding.model.api.WildcardType
177 * string with the package name
179 * string with the type name
180 * @return <code>WildcardType</code> representation of
181 * <code>packageName</code> and <code>typeName</code>
183 public static WildcardType wildcardTypeFor(final String packageName, final String typeName) {
184 return new WildcardTypeImpl(packageName, typeName);
188 * Creates instance of
189 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
190 * ParameterizedType} where raw type is
191 * {@link org.opendaylight.yangtools.yang.binding.Augmentable} and actual
192 * parameter is <code>valueType</code>.
195 * JAVA <code>Type</code> with actual parameter
196 * @return <code>ParametrizedType</code> representation of raw type
197 * <code>Augmentable</code> with actual parameter
198 * <code>valueType</code>
200 public static ParameterizedType augmentableTypeFor(final Type valueType) {
201 final Type augmentable = typeForClass(Augmentable.class);
202 return parameterizedTypeFor(augmentable, valueType);
206 * Creates instance of
207 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
208 * ParameterizedType} where raw type is
209 * {@link org.opendaylight.yangtools.yang.binding.Augmentation} and actual
210 * parameter is <code>valueType</code>.
213 * JAVA <code>Type</code> with actual parameter
214 * @return <code>ParametrizedType</code> reprezentation of raw type
215 * <code>Augmentation</code> with actual parameter
216 * <code>valueType</code>
218 public static ParameterizedType augmentationTypeFor(final Type valueType) {
219 final Type augmentation = typeForClass(Augmentation.class);
220 return parameterizedTypeFor(augmentation, valueType);
224 public static @Nullable String getOuterClassName(final Type valueType) {
225 final String pkgName = valueType.getPackageName();
226 if (CharMatcher.javaUpperCase().indexIn(pkgName) >= 0) {
227 // It is inner class.
228 return Iterables.getLast(DOT_SPLITTER.split(pkgName));
235 * Represents concrete JAVA type.
238 private static final class ConcreteTypeImpl extends AbstractBaseType implements ConcreteType {
239 private final Restrictions restrictions;
242 * Creates instance of this class with package <code>pkName</code> and
243 * with the type name <code>name</code>.
246 * string with package name
248 * string with the name of the type
250 private ConcreteTypeImpl(final String pkName, final String name, final Restrictions restrictions) {
252 this.restrictions = restrictions;
256 public Restrictions getRestrictions() {
257 return this.restrictions;
263 * Represents concrete JAVA type with changed restriction values.
266 private static final class BaseTypeWithRestrictionsImpl extends AbstractBaseType implements BaseTypeWithRestrictions {
267 private final Restrictions restrictions;
270 * Creates instance of this class with package <code>pkName</code> and
271 * with the type name <code>name</code>.
274 * string with package name
276 * string with the name of the type
278 private BaseTypeWithRestrictionsImpl(final String pkName, final String name, final Restrictions restrictions) {
280 this.restrictions = Preconditions.checkNotNull(restrictions);
284 public Restrictions getRestrictions() {
285 return this.restrictions;
291 * Represents parametrized JAVA type.
294 private static class ParametrizedTypeImpl extends AbstractBaseType implements ParameterizedType {
296 * Array of JAVA actual type parameters.
298 private final Type[] actualTypes;
301 * JAVA raw type (like List, Set, Map...)
303 private final Type rawType;
306 public Type[] getActualTypeArguments() {
308 return this.actualTypes;
312 public Type getRawType() {
317 * Creates instance of this class with concrete rawType and array of
321 * JAVA <code>Type</code> for raw type
323 * array of actual parameters
325 public ParametrizedTypeImpl(final Type rawType, final Type[] actTypes) {
326 super(rawType.getPackageName(), rawType.getName());
327 this.rawType = rawType;
328 this.actualTypes = actTypes.clone();
335 * Represents JAVA bounded wildcard type.
338 private static class WildcardTypeImpl extends AbstractBaseType implements WildcardType {
340 * Creates instance of this class with concrete package and type name.
343 * string with the package name
345 * string with the name of type
347 public WildcardTypeImpl(final String packageName, final String typeName) {
348 super(packageName, typeName);
352 public static <T extends Number> DefaultRestrictions<T> getDefaultRestrictions(final T min, final T max) {
353 return new DefaultRestrictions<>(min, max);
356 private static final class DefaultRestrictions<T extends Number> implements Restrictions {
359 private final List<RangeConstraint> rangeConstraints;
361 private DefaultRestrictions(final T min, final T max) {
362 this.min = Preconditions.checkNotNull(min);
363 this.max = Preconditions.checkNotNull(max);
364 this.rangeConstraints = Collections.singletonList(BaseConstraints.newRangeConstraint(min, max, Optional
365 .<String>absent(), Optional.<String>absent()));
369 public boolean isEmpty() {
374 public List<RangeConstraint> getRangeConstraints() {
375 return this.rangeConstraints;
379 public List<PatternConstraint> getPatternConstraints() {
380 return Collections.emptyList();
384 public List<LengthConstraint> getLengthConstraints() {
385 return Collections.emptyList();