import static org.opendaylight.mdsal.binding.model.ri.Types.typeForClass;
import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.VALUE_STATIC_FIELD_NAME;
+import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.binding.model.api.ConcreteType;
import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
import org.opendaylight.mdsal.binding.model.api.GeneratedType;
import org.opendaylight.yangtools.yang.binding.Augmentable;
import org.opendaylight.yangtools.yang.binding.Augmentation;
import org.opendaylight.yangtools.yang.binding.BaseIdentity;
+import org.opendaylight.yangtools.yang.binding.BitsTypeObject;
import org.opendaylight.yangtools.yang.binding.ChildOf;
import org.opendaylight.yangtools.yang.binding.ChoiceIn;
import org.opendaylight.yangtools.yang.binding.DataContainer;
import org.opendaylight.yangtools.yang.binding.Notification;
import org.opendaylight.yangtools.yang.binding.NotificationListener;
import org.opendaylight.yangtools.yang.binding.OpaqueObject;
+import org.opendaylight.yangtools.yang.binding.Rpc;
import org.opendaylight.yangtools.yang.binding.RpcInput;
import org.opendaylight.yangtools.yang.binding.RpcOutput;
import org.opendaylight.yangtools.yang.binding.RpcService;
import org.opendaylight.yangtools.yang.binding.ScalarTypeObject;
-import org.opendaylight.yangtools.yang.binding.TypeObject;
+import org.opendaylight.yangtools.yang.binding.UnionTypeObject;
+import org.opendaylight.yangtools.yang.binding.YangData;
+import org.opendaylight.yangtools.yang.binding.YangFeature;
import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.YangDataName;
import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
public final class BindingTypes {
public static final ConcreteType BASE_IDENTITY = typeForClass(BaseIdentity.class);
public static final ConcreteType DATA_CONTAINER = typeForClass(DataContainer.class);
public static final ConcreteType DATA_OBJECT = typeForClass(DataObject.class);
- public static final ConcreteType TYPE_OBJECT = typeForClass(TypeObject.class);
public static final ConcreteType DATA_ROOT = typeForClass(DataRoot.class);
@Deprecated(since = "10.0.0", forRemoval = true)
public static final ConcreteType NOTIFICATION_LISTENER = typeForClass(NotificationListener.class);
public static final ConcreteType QNAME = typeForClass(QName.class);
public static final ConcreteType RPC_INPUT = typeForClass(RpcInput.class);
public static final ConcreteType RPC_OUTPUT = typeForClass(RpcOutput.class);
+ @Deprecated(since = "11.0.0", forRemoval = true)
public static final ConcreteType RPC_SERVICE = typeForClass(RpcService.class);
public static final ConcreteType SCALAR_TYPE_OBJECT = typeForClass(ScalarTypeObject.class);
+ public static final ConcreteType BITS_TYPE_OBJECT = typeForClass(BitsTypeObject.class);
+ public static final ConcreteType UNION_TYPE_OBJECT = typeForClass(UnionTypeObject.class);
public static final ConcreteType INSTANCE_IDENTIFIER = typeForClass(InstanceIdentifier.class);
public static final ConcreteType KEYED_INSTANCE_IDENTIFIER = typeForClass(KeyedInstanceIdentifier.class);
+ public static final ConcreteType YANG_DATA_NAME = typeForClass(YangDataName.class);
// This is an annotation, we are current just referencing the type
public static final JavaTypeName ROUTING_CONTEXT = JavaTypeName.create(RoutingContext.class);
private static final ConcreteType KEYED_LIST_NOTIFICATION = typeForClass(KeyedListNotification.class);
private static final ConcreteType NOTIFICATION = typeForClass(Notification.class);
private static final ConcreteType OPAQUE_OBJECT = typeForClass(OpaqueObject.class);
+ private static final ConcreteType RPC = typeForClass(Rpc.class);
private static final ConcreteType RPC_RESULT = typeForClass(RpcResult.class);
+ private static final ConcreteType YANG_FEATURE = typeForClass(YangFeature.class);
+ private static final ConcreteType YANG_DATA = typeForClass(YangData.class);
private BindingTypes() {
* @param input Type input type
* @param output Type output type
* @return A parameterized type corresponding to {@code Action<Parent, Input, Output>}
- * @throws NullPointerException if any argument is is null
+ * @throws NullPointerException if any argument is {@code null}
*/
public static ParameterizedType action(final Type parent, final Type input, final Type output) {
return parameterizedTypeFor(ACTION, instanceIdentifier(parent), input, output);
* @param input Type input type
* @param output Type output type
* @return A parameterized type corresponding to {@code KeyedListAction<ParentKey, Parent, Input, Output>}
- * @throws NullPointerException if any argument is is null
+ * @throws NullPointerException if any argument is {@code null}
*/
public static ParameterizedType keyedListAction(final Type parent, final Type keyType, final Type input,
final Type output) {
*
* @param concreteType The concrete type of this notification
* @return A parameterized type corresponding to {@code Notification<ConcreteType>}
- * @throws NullPointerException if any argument is is null
+ * @throws NullPointerException if any argument is {@code null}
*/
public static ParameterizedType notification(final Type concreteType) {
return parameterizedTypeFor(NOTIFICATION, concreteType);
* @param concreteType The concrete type of this notification
* @param parent Type of parent defining the notification
* @return A parameterized type corresponding to {@code InstanceNotification<ConcreteType, Parent>}
- * @throws NullPointerException if {@code parent} is is null
+ * @throws NullPointerException if {@code parent} is {@code null}
*/
public static ParameterizedType instanceNotification(final Type concreteType, final Type parent) {
return parameterizedTypeFor(INSTANCE_NOTIFICATION, concreteType, parent);
* @param parent Type of parent defining the notification
* @param keyType Type of parent's key
* @return A parameterized type corresponding to {@code KeyedInstanceNotification<ConcreteType, ParentKey, Parent>}
- * @throws NullPointerException if any argument is is null
+ * @throws NullPointerException if any argument is {@code null}
*/
public static ParameterizedType keyedListNotification(final Type concreteType, final Type parent,
final Type keyType) {
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code Augmentable<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static @NonNull ParameterizedType augmentable(final Type type) {
return parameterizedTypeFor(AUGMENTABLE, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code Augmentation<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static @NonNull ParameterizedType augmentation(final Type type) {
return parameterizedTypeFor(AUGMENTATION, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code ChildOf<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType childOf(final Type type) {
return parameterizedTypeFor(CHILD_OF, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code ChoiceIn<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType choiceIn(final Type type) {
return parameterizedTypeFor(CHOICE_IN, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code Identifier<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType identifier(final Type type) {
return parameterizedTypeFor(IDENTIFIER, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code Identifiable<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType identifiable(final Type type) {
return parameterizedTypeFor(IDENTIFIABLE, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code InstanceIdentifier<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType instanceIdentifier(final Type type) {
return parameterizedTypeFor(INSTANCE_IDENTIFIER, type);
* @param type Type for which to specialize
* @param keyType Type of key
* @return A parameterized type corresponding to {@code KeyedInstanceIdentifier<Type, KeyType>}
- * @throws NullPointerException if any argument is is null
+ * @throws NullPointerException if any argument is is {@code null}
*/
public static ParameterizedType keyedInstanceIdentifier(final Type type, final Type keyType) {
return parameterizedTypeFor(KEYED_INSTANCE_IDENTIFIER, type, keyType);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code OpaqueObject<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType opaqueObject(final Type type) {
return parameterizedTypeFor(OPAQUE_OBJECT, type);
}
+ /**
+ * Type specializing {@link Rpc} for a particular type.
+ *
+ * @param input Type input type
+ * @param output Type output type
+ * @return A parameterized type corresponding to {@code Rpc<Input, Output>}
+ * @throws NullPointerException if any argument is {@code null}
+ */
+ public static @NonNull ParameterizedType rpc(final Type input, final Type output) {
+ return parameterizedTypeFor(RPC, input, output);
+ }
+
/**
* Type specializing {@link RpcResult} for a particular type.
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code RpcResult<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType rpcResult(final Type type) {
return parameterizedTypeFor(RPC_RESULT, type);
*
* @param type Type for which to specialize
* @return A parameterized type corresponding to {@code ScalarTypeObject<Type>}
- * @throws NullPointerException if {@code type} is null
+ * @throws NullPointerException if {@code type} is {@code null}
*/
public static ParameterizedType scalarTypeObject(final Type type) {
return parameterizedTypeFor(SCALAR_TYPE_OBJECT, type);
}
+ /**
+ * Type specializing {@link YangData} for a particular type.
+ *
+ * @param concreteType The concrete type of this notification
+ * @return A parameterized type corresponding to {@code YangData<Type>}
+ * @throws NullPointerException if any argument is is {@code null}
+ */
+ public static ParameterizedType yangData(final Type concreteType) {
+ return parameterizedTypeFor(YANG_DATA, concreteType);
+ }
+
+ /**
+ * Type specializing {@link YangFeature} for a particular type.
+ *
+ * @param concreteType The concrete type of this notification
+ * @param parent Type of parent defining the notification
+ * @return A parameterized type corresponding to {@code YangFeature<Type, DataRootType>}
+ * @throws NullPointerException if any argument is is {@code null}
+ */
+ public static ParameterizedType yangFeature(final Type concreteType, final Type parent) {
+ return parameterizedTypeFor(YANG_FEATURE, concreteType, parent);
+ }
+
/**
* Check if specified type is generated for a {@code type bits}.
*
* @return {@code true} if the type is generated for a {@code type bits}
*/
public static boolean isBitsType(final Type type) {
- return type instanceof GeneratedTransferObject && isBitsType((GeneratedTransferObject) type);
+ return type instanceof GeneratedTransferObject gto && isBitsType(gto);
}
/**
* @return {@code true} if the type is generated for an identity
*/
public static boolean isIdentityType(final Type type) {
- if (type instanceof GeneratedType) {
- for (var constant : ((GeneratedType) type).getConstantDefinitions()) {
+ if (type instanceof GeneratedType generated) {
+ for (var constant : generated.getConstantDefinitions()) {
if (VALUE_STATIC_FIELD_NAME.equals(constant.getName())
&& BaseIdentity.class.equals(constant.getValue())) {
return true;
}
return false;
}
+
+ /**
+ * Return the {@link Augmentable} type a parameterized {@link Augmentation} type references.
+ *
+ * @param type Parameterized type
+ * @return Augmentable target, or null if {@code type} does not match the result of {@link #augmentation(Type)}
+ * @throws NullPointerException if {@code type} is {@code null}
+ */
+ @Beta
+ public static @Nullable Type extractAugmentable(final ParameterizedType type) {
+ if (AUGMENTATION.equals(type.getRawType())) {
+ final var args = type.getActualTypeArguments();
+ if (args.length == 1) {
+ final var arg = args[0];
+ if (arg != null) {
+ return arg;
+ }
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Return the {@link Identifiable} type a parameterized {@link Identifier} type references.
+ *
+ * @param type Parameterized type
+ * @return Identifiable target, or null if {@code type} does not match the result of {@link #identifier(Type)}
+ * @throws NullPointerException if {@code type} is {@code null}
+ */
+ @Beta
+ public static @Nullable Type extractIdentifiable(final ParameterizedType type) {
+ if (IDENTIFIER.equals(type.getRawType())) {
+ final var args = type.getActualTypeArguments();
+ if (args.length == 1) {
+ final var arg = args[0];
+ if (arg != null) {
+ return arg;
+ }
+ }
+ }
+ return null;
+ }
+
+ @Beta
+ public static @Nullable Type extractYangFeatureDataRoot(final GeneratedTransferObject gto) {
+ if (!gto.isAbstract() && gto.getSuperType() == null) {
+ final var impls = gto.getImplements();
+ if (impls.size() == 1 && impls.get(0) instanceof ParameterizedType param
+ && YANG_FEATURE.equals(param.getRawType())) {
+ final var args = param.getActualTypeArguments();
+ if (args.length == 2) {
+ return args[1];
+ }
+ }
+ }
+ return null;
+ }
}
Code Review / mdsal.git / blobdiff