Remove binding spec2
[mdsal.git] / binding2 / mdsal-binding2-generator-util / src / main / java / org / opendaylight / mdsal / binding / javav2 / generator / util / Types.java
diff --git a/binding2/mdsal-binding2-generator-util/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/util/Types.java b/binding2/mdsal-binding2-generator-util/src/main/java/org/opendaylight/mdsal/binding/javav2/generator/util/Types.java
deleted file mode 100644 (file)
index ff58d6c..0000000
+++ /dev/null
@@ -1,453 +0,0 @@
-/*
- * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-
-package org.opendaylight.mdsal.binding.javav2.generator.util;
-
-import static java.util.Objects.requireNonNull;
-
-import com.google.common.annotations.Beta;
-import com.google.common.base.CharMatcher;
-import com.google.common.base.Splitter;
-import com.google.common.cache.CacheBuilder;
-import com.google.common.cache.CacheLoader;
-import com.google.common.cache.LoadingCache;
-import com.google.common.collect.ImmutableList;
-import com.google.common.collect.ImmutableRangeSet;
-import com.google.common.collect.Iterables;
-import com.google.common.collect.Range;
-import com.google.common.collect.RangeSet;
-
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
-import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
-import org.opendaylight.mdsal.binding.javav2.model.api.BaseTypeWithRestrictions;
-import org.opendaylight.mdsal.binding.javav2.model.api.ConcreteType;
-import org.opendaylight.mdsal.binding.javav2.model.api.ParameterizedType;
-import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
-import org.opendaylight.mdsal.binding.javav2.model.api.Type;
-import org.opendaylight.mdsal.binding.javav2.model.api.WildcardType;
-import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentable;
-import org.opendaylight.mdsal.binding.javav2.spec.structural.Augmentation;
-import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
-import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
-import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
-import org.w3c.dom.Document;
-
-@Beta
-public final class Types {
-    private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER =
-        new CacheLoader<Class<?>, ConcreteType>() {
-
-            @Override
-            public ConcreteType load(@Nonnull final Class<?> key) throws Exception {
-                return new ConcreteTypeImpl(key.getPackage().getName(), key.getSimpleName(), null);
-            }
-        };
-
-    private static final LoadingCache<Class<?>, ConcreteType> TYPE_CACHE =
-            CacheBuilder.newBuilder().weakKeys().build(TYPE_LOADER);
-
-    public static final ConcreteType BOOLEAN = typeForClass(Boolean.class);
-    public static final ConcreteType CLASS = typeForClass(Class.class);
-    public static final ConcreteType STRING = typeForClass(String.class);
-    public static final ConcreteType VOID = typeForClass(Void.class);
-    public static final ConcreteType DOCUMENT = typeForClass(Document.class);
-
-    public static final ConcreteType BYTE_ARRAY = primitiveType("byte[]", null);
-    public static final ConcreteType CHAR_ARRAY = primitiveType("char[]", null);
-
-    private static final Splitter DOT_SPLITTER = Splitter.on('.');
-    private static final Type SET_TYPE = typeForClass(Set.class);
-    private static final Type LIST_TYPE = typeForClass(List.class);
-    private static final Type MAP_TYPE = typeForClass(Map.class);
-
-    private Types() {
-        throw new UnsupportedOperationException("Utility class");
-    }
-
-    /**
-     * Creates the instance of type
-     * {@link ConcreteType
-     * ConcreteType} which represents JAVA <code>void</code> type.
-     *
-     * @return <code>ConcreteType</code> instance which represents JAVA
-     * <code>void</code>
-     */
-    public static ConcreteType voidType() {
-        return VOID;
-    }
-
-    /**
-     * Creates the instance of type
-     * {@link ConcreteType
-     * ConcreteType} which represents primitive JAVA type for which package
-     * doesn't exist.
-     *
-     * @param primitiveType string containing programmatic construction based on
-     *                      primitive type (e.g byte[])
-     * @return <code>ConcreteType</code> instance which represents programmatic
-     *      construction with primitive JAVA type
-     */
-    public static ConcreteType primitiveType(final String primitiveType, final Restrictions restrictions) {
-        return new ConcreteTypeImpl("", primitiveType, restrictions);
-    }
-
-    /**
-     * Returns an instance of {@link ConcreteType} describing the class.
-     *
-     * @param cls Class to describe
-     * @return Description of class
-     */
-    public static ConcreteType typeForClass(final Class<?> cls) {
-        return TYPE_CACHE.getUnchecked(cls);
-    }
-
-
-    public static ConcreteType typeForClass(final Class<?> cls, final Restrictions restrictions) {
-        if (restrictions == null) {
-            return typeForClass(cls);
-        }
-        if (restrictions instanceof DefaultRestrictions) {
-            return new ConcreteTypeImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
-        } else {
-            return new BaseTypeWithRestrictionsImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
-        }
-    }
-
-    public static ConcreteType typeForClass(final Class<?> cls, final Restrictions restrictions,
-                                            final ModuleContext moduleContext) {
-        if (restrictions == null) {
-            return typeForClass(cls);
-        }
-        if (restrictions instanceof DefaultRestrictions) {
-            return new ConcreteTypeImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions);
-        } else {
-            return new BaseTypeWithRestrictionsImpl(cls.getPackage().getName(), cls.getSimpleName(), restrictions,
-                    moduleContext);
-        }
-    }
-
-    /**
-     * Returns an instance of {@link ParameterizedType} describing the typed.
-     * {@link Map}&lt;K,V&gt;
-     *
-     * @param keyType   Key Type
-     * @param valueType Value Type
-     * @return Description of generic type instance
-     */
-    public static ParameterizedType mapTypeFor(final Type keyType, final Type valueType) {
-        return parameterizedTypeFor(MAP_TYPE, keyType, valueType);
-    }
-
-    /**
-     * Returns an instance of {@link ParameterizedType} describing the typed
-     * {@link Set}&lt;V&gt; with concrete type of value.
-     *
-     * @param valueType Value Type
-     * @return Description of generic type instance of Set
-     */
-    public static ParameterizedType setTypeFor(final Type valueType) {
-        return parameterizedTypeFor(SET_TYPE, valueType);
-    }
-
-    /**
-     * Returns an instance of {@link ParameterizedType} describing the typed
-     * {@link List}&lt;V&gt; with concrete type of value.
-     *
-     * @param valueType Value Type
-     * @return Description of type instance of List
-     */
-    public static ParameterizedType listTypeFor(final Type valueType) {
-        return parameterizedTypeFor(LIST_TYPE, valueType);
-    }
-
-    /**
-     * Creates instance of type {@link ParameterizedType ParameterizedType}.
-     *
-     * @param type       JAVA <code>Type</code> for raw type
-     * @param parameters JAVA <code>Type</code>s for actual parameter types
-     * @return <code>ParametrizedType</code> reprezentation of <code>type</code>
-     *      and its parameters <code>parameters</code>
-     */
-    public static ParameterizedType parameterizedTypeFor(final Type type, final Type... parameters) {
-        return new ParameterizedTypeImpl(type, parameters);
-    }
-
-    /**
-     * Creates instance of type {@link WildcardType WildcardType}.
-     *
-     * @param packageName string with the package name
-     * @param typeName    string with the type name
-     * @return <code>WildcardType</code> representation of
-     * <code>packageName</code> and <code>typeName</code>
-     */
-    public static WildcardType wildcardTypeFor(final String packageName, final String typeName) {
-        return new WildcardTypeImpl(packageName, typeName);
-    }
-
-    /**
-     * Creates instance of type {@link WildcardType WildcardType}.
-     *
-     * @param packageName        string with the package name
-     * @param typeName           string with the type name
-     * @param isPkNameNormalized if the package name has been normalized
-     * @param isTypeNormalized   if the type name has been normalized
-     * @return <code>WildcardType</code> representation of
-     * <code>packageName</code> and <code>typeName</code>
-     */
-    public static WildcardType wildcardTypeFor(final String packageName, final String typeName,
-                                               final boolean isPkNameNormalized, final boolean isTypeNormalized,
-                                               final ModuleContext context) {
-        return new WildcardTypeImpl(packageName, typeName, isPkNameNormalized, isTypeNormalized, context);
-    }
-
-    /**
-     * Creates instance of
-     * {@link ParameterizedType
-     * ParameterizedType} where raw type is
-     * {@link Augmentable} and actual
-     * parameter is <code>valueType</code>.
-     *
-     * @param valueType JAVA <code>Type</code> with actual parameter
-     * @return <code>ParametrizedType</code> representation of raw type
-     * <code>Augmentable</code> with actual parameter
-     * <code>valueType</code>
-     */
-    public static ParameterizedType augmentableTypeFor(final Type valueType) {
-        final Type augmentable = typeForClass(Augmentable.class);
-        return parameterizedTypeFor(augmentable, valueType);
-    }
-
-    /**
-     * Creates instance of
-     * {@link ParameterizedType
-     * ParameterizedType} where raw type is
-     * {@link Augmentation} and actual
-     * parameter is <code>valueType</code>.
-     *
-     * @param valueType JAVA <code>Type</code> with actual parameter
-     * @return <code>ParametrizedType</code> reprezentation of raw type
-     * <code>Augmentation</code> with actual parameter
-     * <code>valueType</code>
-     */
-    public static ParameterizedType augmentationTypeFor(final Type valueType) {
-        final Type augmentation = typeForClass(Augmentation.class);
-        return parameterizedTypeFor(augmentation, valueType);
-    }
-
-    @Nullable
-    public static String getOuterClassName(final Type valueType) {
-        final String pkgName = valueType.getPackageName();
-        final int index = CharMatcher.javaUpperCase().indexIn(pkgName);
-        if (index >= 0) {
-            // It is inner class.
-            return Iterables.getFirst(DOT_SPLITTER.split(pkgName.substring(index)), null);
-        }
-        return null;
-    }
-
-    @Nullable
-    public static String getOuterClassPackageName(final Type valueType) {
-        final String pkgName = valueType.getPackageName();
-        final int index = CharMatcher.javaUpperCase().indexIn(pkgName);
-        if (index >= 1) {
-            return pkgName.substring(0, index - 1);
-        }
-        return pkgName;
-    }
-
-    /**
-     * Represents concrete JAVA type.
-     */
-    private static final class ConcreteTypeImpl extends AbstractBaseType implements ConcreteType {
-
-        private final Restrictions restrictions;
-
-        /**
-         * Creates instance of this class with package <code>pkName</code> and
-         * with the type name <code>name</code>.
-         *
-         * @param pkName string with package name
-         * @param name   string with the name of the type
-         */
-        private ConcreteTypeImpl(final String pkName, final String name, final Restrictions restrictions) {
-            super(pkName, name, true, null);
-            this.restrictions = restrictions;
-        }
-
-        @Override
-        public Restrictions getRestrictions() {
-            return this.restrictions;
-        }
-    }
-
-    /**
-     * Represents concrete JAVA type with changed restriction values.
-     */
-    private static final class BaseTypeWithRestrictionsImpl extends AbstractBaseType implements
-            BaseTypeWithRestrictions {
-        private final Restrictions restrictions;
-
-        /**
-         * Creates instance of this class with package <code>pkName</code> and
-         * with the type name <code>name</code>.
-         *
-         * @param pkName string with package name
-         * @param name   string with the name of the type
-         */
-        private BaseTypeWithRestrictionsImpl(final String pkName, final String name, final Restrictions restrictions) {
-            super(pkName, name, null);
-            this.restrictions = requireNonNull(restrictions);
-        }
-
-        private BaseTypeWithRestrictionsImpl(final String pkName, final String name, final Restrictions restrictions,
-                                             final ModuleContext moduleContext) {
-            super(pkName, name, moduleContext);
-            this.restrictions = requireNonNull(restrictions);
-        }
-
-        @Override
-        public Restrictions getRestrictions() {
-            return this.restrictions;
-        }
-    }
-
-    /**
-     * Represents parametrized JAVA type.
-     */
-    private static class ParameterizedTypeImpl extends AbstractBaseType implements ParameterizedType {
-        /**
-         * Array of JAVA actual type parameters.
-         */
-        private final Type[] actualTypes;
-
-        /**
-         * JAVA raw type (like List, Set, Map...).
-         */
-        private final Type rawType;
-
-        /**
-         * Creates instance of this class with concrete rawType and array of
-         * actual parameters.
-         *
-         * @param rawType  JAVA <code>Type</code> for raw type
-         * @param actTypes array of actual parameters
-         */
-        ParameterizedTypeImpl(final Type rawType, final Type[] actTypes) {
-            super(rawType.getPackageName(), rawType.getName(), true, null);
-            this.rawType = rawType;
-            this.actualTypes = actTypes.clone();
-        }
-
-        @Override
-        public Type[] getActualTypeArguments() {
-
-            return this.actualTypes;
-        }
-
-        @Override
-        public Type getRawType() {
-            return this.rawType;
-        }
-    }
-
-    /**
-     * Represents JAVA bounded wildcard type.
-     */
-    private static class WildcardTypeImpl extends AbstractBaseType implements WildcardType {
-        /**
-         * Creates instance of this class with concrete package and type name.
-         *
-         * @param packageName string with the package name
-         * @param typeName    string with the name of type
-         */
-        //FIXME: doesn't seem to be called at all
-        WildcardTypeImpl(final String packageName, final String typeName) {
-            super(packageName, typeName, null);
-        }
-
-        /**
-         * Creates instance of this class with concrete package and type name.
-         *
-         * @param packageName        string with the package name
-         * @param typeName           string with the name of type
-         * @param isPkNameNormalized if the package name has been normalized
-         * @param isTypeNormalized   if the type name has been normalized
-         */
-        WildcardTypeImpl(final String packageName, final String typeName, final boolean isPkNameNormalized,
-                                final boolean isTypeNormalized, final ModuleContext context) {
-            super(packageName, typeName, isPkNameNormalized, isTypeNormalized, context);
-        }
-    }
-
-    public static <T extends Number & Comparable<T>> DefaultRestrictions<T> getDefaultRestrictions(final T min,
-                                                                                                   final T max) {
-        return new DefaultRestrictions<>(min, max);
-    }
-
-    private static final class DefaultRestrictions<T extends Number & Comparable<T>> implements Restrictions {
-        private final RangeConstraint<T> rangeConstraint;
-
-        private DefaultRestrictions(final T min, final T max) {
-            requireNonNull(min);
-            requireNonNull(max);
-            this.rangeConstraint = new RangeConstraint<T>() {
-
-                @Override
-                public Optional<String> getErrorAppTag() {
-                    return Optional.empty();
-                }
-
-                @Override
-                public Optional<String> getErrorMessage() {
-                    return Optional.empty();
-                }
-
-                @Override
-                public Optional<String> getDescription() {
-                    return Optional.empty();
-                }
-
-                @Override
-                public Optional<String> getReference() {
-                    return Optional.empty();
-                }
-
-                @Override
-                public RangeSet<T> getAllowedRanges() {
-                    return ImmutableRangeSet.of(Range.closed(min, max));
-                }
-            };
-        }
-
-        @Override
-        public boolean isEmpty() {
-            return false;
-        }
-
-        @Override
-        public Optional<RangeConstraint<?>> getRangeConstraint() {
-            return Optional.ofNullable(rangeConstraint);
-        }
-
-        @Override
-        public List<PatternConstraint> getPatternConstraints() {
-            return ImmutableList.of();
-        }
-
-        @Override
-        public Optional<LengthConstraint> getLengthConstraint() {
-            return Optional.empty();
-        }
-    }
-}