binding/mdsal-binding-generator-util/src/main/java/org/opendaylight/mdsal/binding/model/util/BindingTypes.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 org.opendaylight.mdsal.binding.model.util.Types.parameterizedTypeFor;
  11 import static org.opendaylight.mdsal.binding.model.util.Types.typeForClass;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  15 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  16 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  17 import org.opendaylight.mdsal.binding.model.api.Type;
  18 import org.opendaylight.yangtools.yang.binding.Action;
  19 import org.opendaylight.yangtools.yang.binding.Augmentable;
  20 import org.opendaylight.yangtools.yang.binding.Augmentation;
  21 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  22 import org.opendaylight.yangtools.yang.binding.ChildOf;
  23 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  24 import org.opendaylight.yangtools.yang.binding.DataContainer;
  25 import org.opendaylight.yangtools.yang.binding.DataObject;
  26 import org.opendaylight.yangtools.yang.binding.DataRoot;
  27 import org.opendaylight.yangtools.yang.binding.Identifiable;
  28 import org.opendaylight.yangtools.yang.binding.Identifier;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.binding.KeyedListAction;
  31 import org.opendaylight.yangtools.yang.binding.Notification;
  32 import org.opendaylight.yangtools.yang.binding.NotificationListener;
  33 import org.opendaylight.yangtools.yang.binding.RpcInput;
  34 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  35 import org.opendaylight.yangtools.yang.binding.RpcService;
  36 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
  37 import org.opendaylight.yangtools.yang.common.RpcResult;
  38
  39 public final class BindingTypes {
  40
  41     public static final ConcreteType BASE_IDENTITY = typeForClass(BaseIdentity.class);
  42     public static final ConcreteType DATA_CONTAINER = typeForClass(DataContainer.class);
  43     public static final ConcreteType DATA_OBJECT = typeForClass(DataObject.class);
  44     public static final ConcreteType DATA_ROOT = typeForClass(DataRoot.class);
  45     public static final ConcreteType NOTIFICATION = typeForClass(Notification.class);
  46     public static final ConcreteType NOTIFICATION_LISTENER = typeForClass(NotificationListener.class);
  47     public static final ConcreteType RPC_INPUT = typeForClass(RpcInput.class);
  48     public static final ConcreteType RPC_OUTPUT = typeForClass(RpcOutput.class);
  49     public static final ConcreteType RPC_SERVICE = typeForClass(RpcService.class);
  50
  51     // This is an annotation, we are current just referencing the type
  52     public static final JavaTypeName ROUTING_CONTEXT = JavaTypeName.create(RoutingContext.class);
  53
  54     @VisibleForTesting
  55     static final ConcreteType AUGMENTABLE = typeForClass(Augmentable.class);
  56     @VisibleForTesting
  57     static final ConcreteType AUGMENTATION = typeForClass(Augmentation.class);
  58     @VisibleForTesting
  59     static final ConcreteType IDENTIFIABLE = typeForClass(Identifiable.class);
  60     @VisibleForTesting
  61     static final ConcreteType IDENTIFIER = typeForClass(Identifier.class);
  62     @VisibleForTesting
  63     static final ConcreteType INSTANCE_IDENTIFIER = typeForClass(InstanceIdentifier.class);
  64
  65     private static final ConcreteType ACTION = typeForClass(Action.class);
  66     private static final ConcreteType CHILD_OF = typeForClass(ChildOf.class);
  67     private static final ConcreteType CHOICE_IN = typeForClass(ChoiceIn.class);
  68     private static final ConcreteType KEYED_LIST_ACTION = typeForClass(KeyedListAction.class);
  69     private static final ConcreteType RPC_RESULT = typeForClass(RpcResult.class);
  70
  71     private BindingTypes() {
  72
  73     }
  74
  75     /**
  76      * Type specializing {@link Action} for a particular type.
  77      *
  78      * @param parent Type of parent defining the action
  79      * @param input Type input type
  80      * @param output Type output type
  81      * @return A parameterized type corresponding to {@code Action<Parent, Input, Output>}
  82      * @throws NullPointerException if any argument is is null
  83      */
  84     public static ParameterizedType action(final Type parent, final Type input, final Type output) {
  85         return parameterizedTypeFor(ACTION, instanceIdentifier(parent), input, output);
  86     }
  87
  88     /**
  89      * Type specializing {@link KeyedListAction} for a particular type.
  90      *
  91      * @param parent Type of parent defining the action
  92      * @param keyType Type of parent's key
  93      * @param input Type input type
  94      * @param output Type output type
  95      * @return A parameterized type corresponding to {@code KeyedListAction<ParentKey, Parent, Input, Output>}
  96      * @throws NullPointerException if any argument is is null
  97      */
  98     public static ParameterizedType keyedListAction(final Type parent, final Type keyType, final Type input,
  99             final Type output) {
 100         return parameterizedTypeFor(KEYED_LIST_ACTION, keyType, parent, input, output);
 101     }
 102
 103     /**
 104      * Specialize {@link Augmentable} for a particular type.
 105      *
 106      * @param type Type for which to specialize
 107      * @return A parameterized type corresponding to {@code Augmentable<Type>}
 108      * @throws NullPointerException if {@code type} is null
 109      */
 110     public static ParameterizedType augmentable(final Type type) {
 111         return parameterizedTypeFor(AUGMENTABLE, type);
 112     }
 113
 114     /**
 115      * Specialize {@link ChildOf} for a particular type.
 116      *
 117      * @param type Type for which to specialize
 118      * @return A parameterized type corresponding to {@code ChildOf<Type>}
 119      * @throws NullPointerException if {@code type} is null
 120      */
 121     public static ParameterizedType childOf(final Type type) {
 122         return parameterizedTypeFor(CHILD_OF, type);
 123     }
 124
 125     /**
 126      * Type specializing {@link ChoiceIn} for a particular type.
 127      *
 128      * @param type Type for which to specialize
 129      * @return A parameterized type corresponding to {@code ChoiceIn<Type>}
 130      * @throws NullPointerException if {@code type} is null
 131      */
 132     public static ParameterizedType choiceIn(final Type type) {
 133         return parameterizedTypeFor(CHOICE_IN, type);
 134     }
 135
 136     /**
 137      * Type specializing {@link Identifier} for a particular type.
 138      *
 139      * @param type Type for which to specialize
 140      * @return A parameterized type corresponding to {@code Identifier<Type>}
 141      * @throws NullPointerException if {@code type} is null
 142      */
 143     public static ParameterizedType identifier(final Type type) {
 144         return parameterizedTypeFor(IDENTIFIER, type);
 145     }
 146
 147     /**
 148      * Type specializing {@link Identifiable} for a particular type.
 149      *
 150      * @param type Type for which to specialize
 151      * @return A parameterized type corresponding to {@code Identifiable<Type>}
 152      * @throws NullPointerException if {@code type} is null
 153      */
 154     public static ParameterizedType identifiable(final Type type) {
 155         return parameterizedTypeFor(IDENTIFIABLE, type);
 156     }
 157
 158     /**
 159      * Type specializing {@link InstanceIdentifier} for a particular type.
 160      *
 161      * @param type Type for which to specialize
 162      * @return A parameterized type corresponding to {@code InstanceIdentifier<Type>}
 163      * @throws NullPointerException if {@code type} is null
 164      */
 165     public static ParameterizedType instanceIdentifier(final Type type) {
 166         return parameterizedTypeFor(INSTANCE_IDENTIFIER, type);
 167     }
 168
 169     /**
 170      * Type specializing {@link RpcResult} for a particular type.
 171      *
 172      * @param type Type for which to specialize
 173      * @return A parameterized type corresponding to {@code RpcResult<Type>}
 174      * @throws NullPointerException if {@code type} is null
 175      */
 176     public static ParameterizedType rpcResult(final Type type) {
 177         return parameterizedTypeFor(RPC_RESULT, type);
 178     }
 179 }