binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/Types.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.mdsal.binding.model.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.cache.CacheBuilder;
  13 import com.google.common.cache.CacheLoader;
  14 import com.google.common.cache.LoadingCache;
  15 import com.google.common.collect.ImmutableRangeSet;
  16 import com.google.common.collect.Range;
  17 import com.google.common.collect.RangeSet;
  18 import com.google.common.util.concurrent.ListenableFuture;
  19 import java.io.Serializable;
  20 import java.util.Arrays;
  21 import java.util.Collections;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Objects;
  25 import java.util.Optional;
  26 import java.util.Set;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.opendaylight.mdsal.binding.model.api.BaseTypeWithRestrictions;
  30 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  31 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  32 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  33 import org.opendaylight.mdsal.binding.model.api.Restrictions;
  34 import org.opendaylight.mdsal.binding.model.api.Type;
  35 import org.opendaylight.mdsal.binding.model.api.WildcardType;
  36 import org.opendaylight.yangtools.concepts.Builder;
  37 import org.opendaylight.yangtools.yang.binding.Augmentation;
  38 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  39 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  40 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  41
  42 public final class Types {
  43     private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER = new CacheLoader<Class<?>, ConcreteType>() {
  44         @Override
  45         public ConcreteType load(final Class<?> key) {
  46             return new ConcreteTypeImpl(JavaTypeName.create(key), null);
  47         }
  48     };
  49     private static final LoadingCache<Class<?>, ConcreteType> TYPE_CACHE =
  50             CacheBuilder.newBuilder().weakKeys().build(TYPE_LOADER);
  51
  52
  53     public static final ConcreteType BOOLEAN = typeForClass(Boolean.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 = typeForClass(byte[].class);
  57
  58     private static final ConcreteType BUILDER = typeForClass(Builder.class);
  59     private static final ConcreteType CLASS = typeForClass(Class.class);
  60     private static final ConcreteType LIST_TYPE = typeForClass(List.class);
  61     private static final ConcreteType LISTENABLE_FUTURE = typeForClass(ListenableFuture.class);
  62     private static final ConcreteType MAP_TYPE = typeForClass(Map.class);
  63     private static final ConcreteType OBJECT = typeForClass(Object.class);
  64     private static final ConcreteType PRIMITIVE_VOID = typeForClass(void.class);
  65     private static final ConcreteType SERIALIZABLE = typeForClass(Serializable.class);
  66     private static final ConcreteType SET_TYPE = typeForClass(Set.class);
  67
  68     /**
  69      * It is not desirable to create instance of this class.
  70      */
  71     private Types() {
  72     }
  73
  74     /**
  75      * Returns an instance of {@link ParameterizedType} which represents JAVA <code>java.lang.Class</code> type
  76      * specialized to specified type.
  77      *
  78      * @param type Type for which to specialize
  79      * @return A parameterized type corresponding to {@code Class<Type>}
  80      * @throws NullPointerException if {@code type} is null
  81      */
  82     public static ParameterizedType classType(final Type type) {
  83         return parameterizedTypeFor(CLASS, type);
  84     }
  85
  86     /**
  87      * Returns an instance of {@link ConcreteType} which represents JAVA <code>java.lang.Void</code> type.
  88      *
  89      * @return <code>ConcreteType</code> instance which represents JAVA <code>java.lang.Void</code>
  90      */
  91     public static ConcreteType voidType() {
  92         return VOID;
  93     }
  94
  95     /**
  96      * Returns an instance of {@link ConcreteType} which represents {@link Object} type.
  97      *
  98      * @return <code>ConcreteType</code> instance which represents {@link Object}
  99      */
 100     public static ConcreteType objectType() {
 101         return OBJECT;
 102     }
 103
 104     /**
 105      * Returns an instance of {@link ConcreteType} which represents JAVA <code>void</code> type.
 106      *
 107      * @return <code>ConcreteType</code> instance which represents JAVA <code>void</code>
 108      */
 109     public static ConcreteType primitiveVoidType() {
 110         return PRIMITIVE_VOID;
 111     }
 112
 113     /**
 114      * Returns an instance of {@link ConcreteType} which represents {@link Serializable} type.
 115      *
 116      * @return <code>ConcreteType</code> instance which represents JAVA <code>{@link Serializable}</code>
 117      */
 118     public static ConcreteType serializableType() {
 119         return SERIALIZABLE;
 120     }
 121
 122     /**
 123      * Returns an instance of {@link ConcreteType} describing the class.
 124      *
 125      * @param cls Class to describe
 126      * @return Description of class
 127      */
 128     public static ConcreteType typeForClass(final Class<?> cls) {
 129         return TYPE_CACHE.getUnchecked(cls);
 130     }
 131
 132     public static ConcreteType typeForClass(final Class<?> cls, final Restrictions restrictions) {
 133         if (restrictions == null) {
 134             return typeForClass(cls);
 135         }
 136
 137         final JavaTypeName identifier = JavaTypeName.create(cls);
 138         if (restrictions instanceof DefaultRestrictions) {
 139             return new ConcreteTypeImpl(identifier, restrictions);
 140         }
 141         return new BaseTypeWithRestrictionsImpl(identifier, restrictions);
 142     }
 143
 144     /**
 145      * Returns an instance of {@link ParameterizedType} describing the typed {@link Map}&lt;K,V&gt;.
 146      *
 147      * @param keyType Key Type
 148      * @param valueType Value Type
 149      * @return Description of generic type instance
 150      */
 151     public static ParameterizedType mapTypeFor(final Type keyType, final Type valueType) {
 152         return parameterizedTypeFor(MAP_TYPE, keyType, valueType);
 153     }
 154
 155     /**
 156      * Returns an instance of {@link ParameterizedType} describing the typed {@link Set}&lt;V&gt; with concrete type
 157      * of value.
 158      *
 159      * @param valueType Value Type
 160      * @return Description of generic type instance of Set
 161      */
 162     public static ParameterizedType setTypeFor(final Type valueType) {
 163         return parameterizedTypeFor(SET_TYPE, valueType);
 164     }
 165
 166     /**
 167      * Returns an instance of {@link ParameterizedType} describing the typed {@link List}&lt;V&gt; with concrete type
 168      * of value.
 169      *
 170      * @param valueType Value Type
 171      * @return Description of type instance of List
 172      */
 173     public static ParameterizedType listTypeFor(final Type valueType) {
 174         return parameterizedTypeFor(LIST_TYPE, valueType);
 175     }
 176
 177     public static boolean isListType(final ParameterizedType type) {
 178         return LIST_TYPE.equals(type.getRawType());
 179     }
 180
 181     public static boolean isListType(final Type type) {
 182         return type instanceof ParameterizedType && isListType((ParameterizedType) type);
 183     }
 184
 185     /**
 186      * Returns an instance of {@link ParameterizedType} describing the typed {@link ListenableFuture}&lt;V&gt;
 187      * with concrete type of value.
 188      *
 189      * @param valueType Value Type
 190      * @return Description of type instance of ListenableFuture
 191      */
 192     public static ParameterizedType listenableFutureTypeFor(final Type valueType) {
 193         return parameterizedTypeFor(LISTENABLE_FUTURE, valueType);
 194     }
 195
 196     /**
 197      * Returns an instance of {@link ParameterizedType} describing the typed
 198      * {@link Builder}&lt;V&gt; with concrete type of value.
 199      *
 200      * @param valueType Value Type
 201      * @return Description of type instance of Builder
 202      */
 203     public static ParameterizedType builderTypeFor(final Type valueType) {
 204         return parameterizedTypeFor(BUILDER, valueType);
 205     }
 206
 207     /**
 208      * Creates instance of type {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType ParameterizedType}.
 209      *
 210      * @param type JAVA <code>Type</code> for raw type
 211      * @param parameters JAVA <code>Type</code>s for actual parameter types
 212      * @return <code>ParametrizedType</code> representation of <code>type</code> and its <code>parameters</code>
 213      * @throws NullPointerException if any argument or any member of {@code parameters} is null
 214      */
 215     public static ParameterizedType parameterizedTypeFor(final Type type, final Type... parameters) {
 216         return new ParametrizedTypeImpl(type, parameters);
 217     }
 218
 219     /**
 220      * Creates instance of type {@link org.opendaylight.mdsal.binding.model.api.WildcardType}.
 221      *
 222      * @param identifier JavaTypeName of the type
 223      * @return <code>WildcardType</code> representation of specified identifier
 224      */
 225     public static WildcardType wildcardTypeFor(final JavaTypeName identifier) {
 226         return new WildcardTypeImpl(identifier);
 227     }
 228
 229     /**
 230      * Creates instance of
 231      * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
 232      * ParameterizedType} where raw type is
 233      * {@link org.opendaylight.yangtools.yang.binding.Augmentable} and actual
 234      * parameter is <code>valueType</code>.
 235      *
 236      * @param valueType JAVA <code>Type</code> with actual parameter
 237      * @return <code>ParametrizedType</code> representation of raw type
 238      *         <code>Augmentable</code> with actual parameter
 239      *         <code>valueType</code>
 240      * @deprecated Use {@link BindingTypes#augmentable(Type)} instead.
 241      */
 242     @Deprecated
 243     public static @NonNull ParameterizedType augmentableTypeFor(final Type valueType) {
 244         return BindingTypes.augmentable(valueType);
 245     }
 246
 247     /**
 248      * Creates instance of {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType ParameterizedType} where
 249      * raw type is {@link org.opendaylight.yangtools.yang.binding.Augmentation} and actual parameter
 250      * is <code>valueType</code>.
 251      *
 252      * @param valueType JAVA <code>Type</code> with actual parameter
 253      * @return <code>ParametrizedType</code> reprezentation of raw type
 254      *         <code>Augmentation</code> with actual parameter
 255      *         <code>valueType</code>
 256      */
 257     public static ParameterizedType augmentationTypeFor(final Type valueType) {
 258         final Type augmentation = typeForClass(Augmentation.class);
 259         return parameterizedTypeFor(augmentation, valueType);
 260     }
 261
 262     public static @Nullable String getOuterClassName(final Type valueType) {
 263         return valueType.getIdentifier().immediatelyEnclosingClass().map(Object::toString).orElse(null);
 264     }
 265
 266     /**
 267      * Represents concrete JAVA type.
 268      */
 269     private static final class ConcreteTypeImpl extends AbstractBaseType implements ConcreteType {
 270         private final Restrictions restrictions;
 271
 272         /**
 273          * Creates instance of this class with package <code>pkName</code> and with the type name <code>name</code>.
 274          *
 275          * @param pkName string with package name
 276          * @param name string with the name of the type
 277          */
 278         ConcreteTypeImpl(final JavaTypeName identifier, final Restrictions restrictions) {
 279             super(identifier);
 280             this.restrictions = restrictions;
 281         }
 282
 283         @Override
 284         public Restrictions getRestrictions() {
 285             return this.restrictions;
 286         }
 287     }
 288
 289     /**
 290      * Represents concrete JAVA type with changed restriction values.
 291      */
 292     private static final class BaseTypeWithRestrictionsImpl extends AbstractBaseType implements
 293             BaseTypeWithRestrictions {
 294         private final Restrictions restrictions;
 295
 296         /**
 297          * Creates instance of this class with package <code>pkName</code> and with the type name <code>name</code>.
 298          *
 299          * @param pkName string with package name
 300          * @param name string with the name of the type
 301          */
 302         BaseTypeWithRestrictionsImpl(final JavaTypeName identifier, final Restrictions restrictions) {
 303             super(identifier);
 304             this.restrictions = requireNonNull(restrictions);
 305         }
 306
 307         @Override
 308         public Restrictions getRestrictions() {
 309             return this.restrictions;
 310         }
 311     }
 312
 313     /**
 314      * Represents parametrized JAVA type.
 315      */
 316     private static class ParametrizedTypeImpl extends AbstractBaseType implements ParameterizedType {
 317         /**
 318          * Array of JAVA actual type parameters.
 319          */
 320         private final Type[] actualTypes;
 321
 322         /**
 323          * JAVA raw type (like List, Set, Map...).
 324          */
 325         private final Type rawType;
 326
 327         /**
 328          * Creates instance of this class with concrete rawType and array of actual parameters.
 329          *
 330          * @param rawType JAVA <code>Type</code> for raw type
 331          * @param actTypes array of actual parameters
 332          */
 333         ParametrizedTypeImpl(final Type rawType, final Type[] actTypes) {
 334             super(rawType.getIdentifier());
 335             this.rawType = requireNonNull(rawType);
 336             actualTypes = actTypes.clone();
 337             if (Arrays.stream(actualTypes).anyMatch(Objects::isNull)) {
 338                 throw new NullPointerException("actTypes contains a null");
 339             }
 340         }
 341
 342         @Override
 343         public Type[] getActualTypeArguments() {
 344
 345             return this.actualTypes;
 346         }
 347
 348         @Override
 349         public Type getRawType() {
 350             return this.rawType;
 351         }
 352     }
 353
 354     /**
 355      * Represents JAVA bounded wildcard type.
 356      */
 357     private static class WildcardTypeImpl extends AbstractBaseType implements WildcardType {
 358         /**
 359          * Creates instance of this class with concrete package and type name.
 360          *
 361          * @param packageName string with the package name
 362          * @param typeName string with the name of type
 363          */
 364         WildcardTypeImpl(final JavaTypeName identifier) {
 365             super(identifier);
 366         }
 367     }
 368
 369     public static <T extends Number & Comparable<T>> DefaultRestrictions<T> getDefaultRestrictions(final T min,
 370             final T max) {
 371         return new DefaultRestrictions<>(min, max);
 372     }
 373
 374     private static final class DefaultRestrictions<T extends Number & Comparable<T>> implements Restrictions {
 375         private final RangeConstraint<?> rangeConstraint;
 376
 377         DefaultRestrictions(final T min, final T max) {
 378             this.rangeConstraint = new DefaultRangeConstraint<>(min, max);
 379         }
 380
 381         @Override
 382         public boolean isEmpty() {
 383             return false;
 384         }
 385
 386         @Override
 387         public Optional<? extends RangeConstraint<?>> getRangeConstraint() {
 388             return Optional.of(rangeConstraint);
 389         }
 390
 391         @Override
 392         public List<PatternConstraint> getPatternConstraints() {
 393             return Collections.emptyList();
 394         }
 395
 396         @Override
 397         public Optional<LengthConstraint> getLengthConstraint() {
 398             return Optional.empty();
 399         }
 400     }
 401
 402     private static final class DefaultRangeConstraint<T extends Number & Comparable<T>> implements RangeConstraint<T> {
 403         private final T min;
 404         private final T max;
 405
 406         DefaultRangeConstraint(final T min, final T max) {
 407             this.min = requireNonNull(min);
 408             this.max = requireNonNull(max);
 409         }
 410
 411         @Override
 412         public Optional<String> getErrorAppTag() {
 413             return Optional.empty();
 414         }
 415
 416         @Override
 417         public Optional<String> getErrorMessage() {
 418             return Optional.empty();
 419         }
 420
 421         @Override
 422         public Optional<String> getDescription() {
 423             return Optional.empty();
 424         }
 425
 426         @Override
 427         public Optional<String> getReference() {
 428             return Optional.empty();
 429         }
 430
 431         @Override
 432         public RangeSet<T> getAllowedRanges() {
 433             return ImmutableRangeSet.of(Range.closed(min, max));
 434         }
 435     }
 436 }