*/
package org.opendaylight.mdsal.binding.model.util;
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.collect.RangeSet;
import com.google.common.util.concurrent.ListenableFuture;
import java.io.Serializable;
+import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Optional;
import java.util.Set;
+import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.binding.model.api.BaseTypeWithRestrictions;
import org.opendaylight.mdsal.binding.model.api.ConcreteType;
import org.opendaylight.mdsal.binding.model.api.Restrictions;
import org.opendaylight.mdsal.binding.model.api.Type;
import org.opendaylight.mdsal.binding.model.api.WildcardType;
-import org.opendaylight.yangtools.yang.binding.Augmentable;
+import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.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;
public final class Types {
- private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER =
- new CacheLoader<Class<?>, ConcreteType>() {
- @Override
- public ConcreteType load(final Class<?> key) {
- return new ConcreteTypeImpl(JavaTypeName.create(key), null);
- }
+ private static final CacheLoader<Class<?>, ConcreteType> TYPE_LOADER = new CacheLoader<Class<?>, ConcreteType>() {
+ @Override
+ public ConcreteType load(final Class<?> key) {
+ return new ConcreteTypeImpl(JavaTypeName.create(key), null);
+ }
};
private static final LoadingCache<Class<?>, ConcreteType> TYPE_CACHE =
CacheBuilder.newBuilder().weakKeys().build(TYPE_LOADER);
- public static final Type SET_TYPE = typeForClass(Set.class);
- public static final Type LIST_TYPE = typeForClass(List.class);
- public static final Type MAP_TYPE = typeForClass(Map.class);
public static final ConcreteType BOOLEAN = typeForClass(Boolean.class);
- public static final ConcreteType FUTURE = typeForClass(ListenableFuture.class);
public static final ConcreteType STRING = typeForClass(String.class);
public static final ConcreteType VOID = typeForClass(Void.class);
public static final ConcreteType BYTE_ARRAY = typeForClass(byte[].class);
- public static final ConcreteType CHAR_ARRAY = typeForClass(char[].class);
+ private static final ConcreteType BUILDER = typeForClass(Builder.class);
private static final ConcreteType CLASS = typeForClass(Class.class);
+ private static final ConcreteType LIST_TYPE = typeForClass(List.class);
+ private static final ConcreteType LISTENABLE_FUTURE = typeForClass(ListenableFuture.class);
+ private static final ConcreteType MAP_TYPE = typeForClass(Map.class);
private static final ConcreteType OBJECT = typeForClass(Object.class);
private static final ConcreteType PRIMITIVE_VOID = typeForClass(void.class);
private static final ConcreteType SERIALIZABLE = typeForClass(Serializable.class);
+ private static final ConcreteType SET_TYPE = typeForClass(Set.class);
/**
- * It is not desirable to create instance of this class
+ * It is not desirable to create instance of this class.
*/
private Types() {
}
}
/**
- * Returns an instance of {@link ConcreteType} describing the class
+ * Returns an instance of {@link ConcreteType} describing the class.
*
- * @param cls
- * Class to describe
+ * @param cls Class to describe
* @return Description of class
*/
public static ConcreteType typeForClass(final Class<?> cls) {
}
/**
- * Returns an instance of {@link ParameterizedType} describing the typed
- * {@link Map}<K,V>
+ * Returns an instance of {@link ParameterizedType} describing the typed {@link Map}<K,V>.
*
- * @param keyType
- * Key Type
- * @param valueType
- * Value Type
+ * @param keyType Key Type
+ * @param valueType Value Type
* @return Description of generic type instance
*/
public static ParameterizedType mapTypeFor(final Type keyType, final Type valueType) {
}
/**
- * Returns an instance of {@link ParameterizedType} describing the typed
- * {@link Set}<V> with concrete type of value.
+ * Returns an instance of {@link ParameterizedType} describing the typed {@link Set}<V> with concrete type
+ * of value.
*
- * @param valueType
- * Value Type
+ * @param valueType Value Type
* @return Description of generic type instance of Set
*/
public static ParameterizedType setTypeFor(final Type valueType) {
}
/**
- * Returns an instance of {@link ParameterizedType} describing the typed
- * {@link List}<V> with concrete type of value.
+ * Returns an instance of {@link ParameterizedType} describing the typed {@link List}<V> with concrete type
+ * of value.
*
- * @param valueType
- * Value Type
+ * @param valueType Value Type
* @return Description of type instance of List
*/
public static ParameterizedType listTypeFor(final Type valueType) {
return parameterizedTypeFor(LIST_TYPE, valueType);
}
+ public static boolean isListType(final ParameterizedType type) {
+ return LIST_TYPE.equals(type.getRawType());
+ }
+
+ public static boolean isListType(final Type type) {
+ return type instanceof ParameterizedType && isListType((ParameterizedType) type);
+ }
+
/**
- * Creates instance of type
- * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
- * ParameterizedType}
+ * Returns an instance of {@link ParameterizedType} describing the typed {@link ListenableFuture}<V>
+ * with concrete type of value.
+ *
+ * @param valueType Value Type
+ * @return Description of type instance of ListenableFuture
+ */
+ public static ParameterizedType listenableFutureTypeFor(final Type valueType) {
+ return parameterizedTypeFor(LISTENABLE_FUTURE, valueType);
+ }
+
+ /**
+ * Returns an instance of {@link ParameterizedType} describing the typed
+ * {@link Builder}<V> with concrete type of value.
*
- * @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>
- * @throws NullPointerException if any argument is null
+ * @param valueType Value Type
+ * @return Description of type instance of Builder
+ */
+ public static ParameterizedType builderTypeFor(final Type valueType) {
+ return parameterizedTypeFor(BUILDER, valueType);
+ }
+
+ /**
+ * Creates instance of type {@link org.opendaylight.mdsal.binding.model.api.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> representation of <code>type</code> and its <code>parameters</code>
+ * @throws NullPointerException if any argument or any member of {@code parameters} is null
*/
public static ParameterizedType parameterizedTypeFor(final Type type, final Type... parameters) {
return new ParametrizedTypeImpl(type, parameters);
* {@link org.opendaylight.yangtools.yang.binding.Augmentable} and actual
* parameter is <code>valueType</code>.
*
- * @param valueType
- * JAVA <code>Type</code> with actual parameter
+ * @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>
+ * @deprecated Use {@link BindingTypes#augmentable(Type)} instead.
*/
- public static ParameterizedType augmentableTypeFor(final Type valueType) {
- final Type augmentable = typeForClass(Augmentable.class);
- return parameterizedTypeFor(augmentable, valueType);
+ @Deprecated
+ public static @NonNull ParameterizedType augmentableTypeFor(final Type valueType) {
+ return BindingTypes.augmentable(valueType);
}
/**
- * Creates instance of
- * {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType
- * ParameterizedType} where raw type is
- * {@link org.opendaylight.yangtools.yang.binding.Augmentation} and actual
- * parameter is <code>valueType</code>.
+ * Creates instance of {@link org.opendaylight.mdsal.binding.model.api.ParameterizedType ParameterizedType} where
+ * raw type is {@link org.opendaylight.yangtools.yang.binding.Augmentation} and actual parameter
+ * is <code>valueType</code>.
*
- * @param valueType
- * JAVA <code>Type</code> with actual parameter
+ * @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>
}
/**
- *
* 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>.
+ * 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
+ * @param pkName string with package name
+ * @param name string with the name of the type
*/
ConcreteTypeImpl(final JavaTypeName identifier, final Restrictions restrictions) {
super(identifier);
/**
* Represents concrete JAVA type with changed restriction values.
*/
- private static final class BaseTypeWithRestrictionsImpl extends AbstractBaseType implements BaseTypeWithRestrictions {
+ 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>.
+ * 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
+ * @param pkName string with package name
+ * @param name string with the name of the type
*/
BaseTypeWithRestrictionsImpl(final JavaTypeName identifier, final Restrictions restrictions) {
super(identifier);
- this.restrictions = Preconditions.checkNotNull(restrictions);
+ this.restrictions = requireNonNull(restrictions);
}
@Override
private final Type[] actualTypes;
/**
- * JAVA raw type (like List, Set, Map...)
+ * 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
+ */
+ ParametrizedTypeImpl(final Type rawType, final Type[] actTypes) {
+ super(rawType.getIdentifier());
+ this.rawType = requireNonNull(rawType);
+ actualTypes = actTypes.clone();
+ if (Arrays.stream(actualTypes).anyMatch(Objects::isNull)) {
+ throw new NullPointerException("actTypes contains a null");
+ }
+ }
+
@Override
public Type[] getActualTypeArguments() {
public Type getRawType() {
return this.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
- */
- public ParametrizedTypeImpl(final Type rawType, final Type[] actTypes) {
- super(rawType.getIdentifier());
- this.rawType = rawType;
- this.actualTypes = actTypes.clone();
- }
}
/**
/**
* 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 packageName string with the package name
+ * @param typeName string with the name of type
*/
WildcardTypeImpl(final JavaTypeName identifier) {
super(identifier);
}
}
- public static <T extends Number& Comparable<T>> DefaultRestrictions<T> getDefaultRestrictions(final T min,
+ 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 T min;
- private final T max;
private final RangeConstraint<?> rangeConstraint;
- private DefaultRestrictions(final T min, final T max) {
- this.min = Preconditions.checkNotNull(min);
- this.max = Preconditions.checkNotNull(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));
- }
- };
+ DefaultRestrictions(final T min, final T max) {
+ this.rangeConstraint = new DefaultRangeConstraint<>(min, max);
}
@Override
return Optional.empty();
}
}
+
+ private static final class DefaultRangeConstraint<T extends Number & Comparable<T>> implements RangeConstraint<T> {
+ private final T min;
+ private final T max;
+
+ DefaultRangeConstraint(final T min, final T max) {
+ this.min = requireNonNull(min);
+ this.max = requireNonNull(max);
+ }
+
+ @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));
+ }
+ }
}
Code Review / mdsal.git / blobdiff