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