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.Preconditions;
12 import com.google.common.base.Splitter;
13 import com.google.common.cache.CacheBuilder;
14 import com.google.common.cache.CacheLoader;
15 import com.google.common.cache.LoadingCache;
16 import com.google.common.collect.ImmutableRangeSet;
17 import com.google.common.collect.Iterables;
18 import com.google.common.collect.Range;
19 import com.google.common.collect.RangeSet;
20 import java.util.Collections;
21 import java.util.List;
23 import java.util.Optional;
25 import java.util.concurrent.Future;
26 import javax.annotation.Nullable;
27 import org.opendaylight.mdsal.binding.model.api.BaseTypeWithRestrictions;
28 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
29 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
30 import org.opendaylight.mdsal.binding.model.api.Restrictions;
31 import org.opendaylight.mdsal.binding.model.api.Type;
32 import org.opendaylight.mdsal.binding.model.api.WildcardType;
33 import org.opendaylight.yangtools.yang.binding.Augmentable;
34 import org.opendaylight.yangtools.yang.binding.Augmentation;
35 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
36 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
37 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
39 public final class Types {
40 private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER =
41 new CacheLoader<Class<?>, ConcreteType>() {
43 public ConcreteType load(final Class<?> key) {
44 return new ConcreteTypeImpl(key.getPackage().getName(), key.getSimpleName(), null);
47 private static final LoadingCache<Class<?>, ConcreteType> TYPE_CACHE =
48 CacheBuilder.newBuilder().weakKeys().build(TYPE_LOADER);
50 private static final Type SET_TYPE = typeForClass(Set.class);
51 private static final Type LIST_TYPE = typeForClass(List.class);
52 private static final Type MAP_TYPE = typeForClass(Map.class);
54 public static final ConcreteType BOOLEAN = typeForClass(Boolean.class);
55 public static final ConcreteType FUTURE = typeForClass(Future.class);
56 public static final ConcreteType STRING = typeForClass(String.class);
57 public static final ConcreteType VOID = typeForClass(Void.class);
58 public static final ConcreteType BYTE_ARRAY = primitiveType("byte[]", null);
59 public static final ConcreteType CHAR_ARRAY = primitiveType("char[]", null);
60 private static final Splitter DOT_SPLITTER = Splitter.on('.');
63 * It is not desirable to create instance of this class
69 * Creates the instance of type
70 * {@link org.opendaylight.mdsal.binding.model.api.ConcreteType
71 * ConcreteType} which represents JAVA <code>void</code> type.
73 * @return <code>ConcreteType</code> instance which represents JAVA
76 public static ConcreteType voidType() {
81 * Creates the instance of type
82 * {@link org.opendaylight.mdsal.binding.model.api.ConcreteType
83 * ConcreteType} which represents primitive JAVA type for which package
86 * @param primitiveType
87 * string containing programmatic construction based on
88 * primitive type (e.g byte[])
91 * @return <code>ConcreteType</code> instance which represents programmatic
92 * construction with primitive JAVA type
94 public static ConcreteType primitiveType(final String primitiveType, final Restrictions restrictions) {
95 return new ConcreteTypeImpl("", primitiveType, restrictions);
99 * Returns an instance of {@link ConcreteType} describing the class
103 * @return Description of class
105 public static ConcreteType typeForClass(final Class<?> cls) {
106 return TYPE_CACHE.getUnchecked(cls);
109 public static ConcreteType typeForClass(final Class<?> cls, final Restrictions restrictions) {
110 if (restrictions == null) {
111 return typeForClass(cls);
113 if (restrictions instanceof DefaultRestrictions) {
114 return new ConcreteTypeImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
116 return new BaseTypeWithRestrictionsImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
120 * Returns an instance of {@link ParameterizedType} describing the typed
121 * {@link Map}<K,V>
127 * @return Description of generic type instance
129 public static ParameterizedType mapTypeFor(final Type keyType, final Type valueType) {
130 return parameterizedTypeFor(MAP_TYPE, keyType, valueType);
134 * Returns an instance of {@link ParameterizedType} describing the typed
135 * {@link Set}<V> with concrete type of value.
139 * @return Description of generic type instance of Set
141 public static ParameterizedType setTypeFor(final Type valueType) {
142 return parameterizedTypeFor(SET_TYPE, valueType);
146 * Returns an instance of {@link ParameterizedType} describing the typed
147 * {@link List}<V> with concrete type of value.
151 * @return Description of type instance of List
153 public static ParameterizedType listTypeFor(final Type valueType) {
154 return parameterizedTypeFor(LIST_TYPE, valueType);
158 * Creates instance of type
159 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
163 * JAVA <code>Type</code> for raw type
165 * JAVA <code>Type</code>s for actual parameter types
166 * @return <code>ParametrizedType</code> reprezentation of <code>type</code>
167 * and its parameters <code>parameters</code>
169 public static ParameterizedType parameterizedTypeFor(final Type type, final Type... parameters) {
170 return new ParametrizedTypeImpl(type, parameters);
174 * Creates instance of type
175 * {@link org.opendaylight.mdsal.binding.model.api.WildcardType
179 * string with the package name
181 * string with the type name
182 * @return <code>WildcardType</code> representation of
183 * <code>packageName</code> and <code>typeName</code>
185 public static WildcardType wildcardTypeFor(final String packageName, final String typeName) {
186 return new WildcardTypeImpl(packageName, typeName);
190 * Creates instance of
191 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
192 * ParameterizedType} where raw type is
193 * {@link org.opendaylight.yangtools.yang.binding.Augmentable} and actual
194 * parameter is <code>valueType</code>.
197 * JAVA <code>Type</code> with actual parameter
198 * @return <code>ParametrizedType</code> representation of raw type
199 * <code>Augmentable</code> with actual parameter
200 * <code>valueType</code>
202 public static ParameterizedType augmentableTypeFor(final Type valueType) {
203 final Type augmentable = typeForClass(Augmentable.class);
204 return parameterizedTypeFor(augmentable, valueType);
208 * Creates instance of
209 * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
210 * ParameterizedType} where raw type is
211 * {@link org.opendaylight.yangtools.yang.binding.Augmentation} and actual
212 * parameter is <code>valueType</code>.
215 * JAVA <code>Type</code> with actual parameter
216 * @return <code>ParametrizedType</code> reprezentation of raw type
217 * <code>Augmentation</code> with actual parameter
218 * <code>valueType</code>
220 public static ParameterizedType augmentationTypeFor(final Type valueType) {
221 final Type augmentation = typeForClass(Augmentation.class);
222 return parameterizedTypeFor(augmentation, valueType);
226 public static @Nullable String getOuterClassName(final Type valueType) {
227 final String pkgName = valueType.getPackageName();
228 if (CharMatcher.javaUpperCase().indexIn(pkgName) >= 0) {
229 // It is inner class.
230 return Iterables.getLast(DOT_SPLITTER.split(pkgName));
237 * Represents concrete JAVA type.
240 private static final class ConcreteTypeImpl extends AbstractBaseType implements ConcreteType {
241 private final Restrictions restrictions;
244 * Creates instance of this class with package <code>pkName</code> and
245 * with the type name <code>name</code>.
248 * string with package name
250 * string with the name of the type
252 private ConcreteTypeImpl(final String pkName, final String name, final Restrictions restrictions) {
254 this.restrictions = restrictions;
258 public Restrictions getRestrictions() {
259 return this.restrictions;
264 * 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;
290 * Represents parametrized JAVA type.
292 private static class ParametrizedTypeImpl extends AbstractBaseType implements ParameterizedType {
294 * Array of JAVA actual type parameters.
296 private final Type[] actualTypes;
299 * JAVA raw type (like List, Set, Map...)
301 private final Type rawType;
304 public Type[] getActualTypeArguments() {
306 return this.actualTypes;
310 public Type getRawType() {
315 * Creates instance of this class with concrete rawType and array of
319 * JAVA <code>Type</code> for raw type
321 * array of actual parameters
323 public ParametrizedTypeImpl(final Type rawType, final Type[] actTypes) {
324 super(rawType.getPackageName(), rawType.getName());
325 this.rawType = rawType;
326 this.actualTypes = actTypes.clone();
332 * Represents JAVA bounded wildcard type.
334 private static class WildcardTypeImpl extends AbstractBaseType implements WildcardType {
336 * Creates instance of this class with concrete package and type name.
339 * string with the package name
341 * string with the name of type
343 public WildcardTypeImpl(final String packageName, final String typeName) {
344 super(packageName, typeName);
348 public static <T extends Number& Comparable<T>> DefaultRestrictions<T> getDefaultRestrictions(final T min,
350 return new DefaultRestrictions<>(min, max);
353 private static final class DefaultRestrictions<T extends Number & Comparable<T>> implements Restrictions {
356 private final RangeConstraint<?> rangeConstraint;
358 private DefaultRestrictions(final T min, final T max) {
359 this.min = Preconditions.checkNotNull(min);
360 this.max = Preconditions.checkNotNull(max);
362 this.rangeConstraint = new RangeConstraint<T>() {
365 public Optional<String> getErrorAppTag() {
366 return Optional.empty();
370 public Optional<String> getErrorMessage() {
371 return Optional.empty();
375 public Optional<String> getDescription() {
376 return Optional.empty();
380 public Optional<String> getReference() {
381 return Optional.empty();
385 public RangeSet<T> getAllowedRanges() {
386 return ImmutableRangeSet.of(Range.closed(min, max));
392 public boolean isEmpty() {
397 public Optional<? extends RangeConstraint<?>> getRangeConstraint() {
398 return Optional.of(rangeConstraint);
402 public List<PatternConstraint> getPatternConstraints() {
403 return Collections.emptyList();
407 public Optional<LengthConstraint> getLengthConstraint() {
408 return Optional.empty();