opendaylight/config/yang-jmx-generator-plugin/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/plugin/ftl/model/Annotation.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.controller.config.yangjmxgenerator.plugin.ftl.model;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collection;
  12 import java.util.List;
  13
  14 import org.opendaylight.controller.config.api.annotations.Description;
  15 import org.opendaylight.controller.config.api.annotations.RequireInterface;
  16 import org.opendaylight.controller.config.api.annotations.ServiceInterfaceAnnotation;
  17 import org.opendaylight.yangtools.yang.binding.annotations.ModuleQName;
  18 import org.opendaylight.controller.config.yangjmxgenerator.ServiceInterfaceEntry;
  19
  20 import com.google.common.base.Preconditions;
  21 import com.google.common.collect.Lists;
  22
  23 public class Annotation {
  24     final String name;
  25     final List<Parameter> params;
  26
  27     public Annotation(String name, List<Parameter> params) {
  28         this.name = name;
  29         this.params = params;
  30     }
  31
  32     public String getName() {
  33         return name;
  34     }
  35
  36     public List<Parameter> getParams() {
  37         return params;
  38     }
  39
  40     public static Annotation createDescriptionAnnotation(String description) {
  41         Preconditions.checkNotNull(description,
  42                 "Cannot create annotation from null description");
  43         return new Annotation(Description.class.getCanonicalName(),
  44                 Lists.newArrayList(new Parameter("value", q(description))));
  45     }
  46
  47     public static Collection<Annotation> createSieAnnotations(ServiceInterfaceEntry sie){
  48
  49         String exportedClassName = sie.getExportedOsgiClassName();
  50         Preconditions.checkNotNull(sie.getQName(),
  51                 "Cannot create annotation from null qname");
  52         Preconditions.checkNotNull(exportedClassName,
  53                 "Cannot create annotation from null exportedClassName");
  54         List<Annotation> result = new ArrayList<>();
  55         {
  56             List<Parameter> params = Lists.newArrayList(new Parameter("value", q(sie.getQName().toString())));
  57             params.add(new Parameter("osgiRegistrationType", exportedClassName + ".class"));
  58
  59             params.add(new Parameter("namespace", q(sie.getQName().getNamespace().toString())));
  60             params.add(new Parameter("revision", q(sie.getQName().getFormattedRevision())));
  61             params.add(new Parameter("localName", q(sie.getQName().getLocalName())));
  62
  63             Annotation sieAnnotation = new Annotation(ServiceInterfaceAnnotation.class.getCanonicalName(), params);
  64             result.add(sieAnnotation);
  65
  66         }
  67         {
  68             List<Parameter> params = new ArrayList<>();
  69             params.add(new Parameter("namespace", q(sie.getYangModuleQName().getNamespace().toString())));
  70             params.add(new Parameter("revision", q(sie.getYangModuleQName().getFormattedRevision())));
  71             params.add(new Parameter("name", q(sie.getYangModuleQName().getLocalName())));
  72
  73             Annotation moduleQNameAnnotation = new Annotation(ModuleQName.class.getCanonicalName(), params);
  74             result.add(moduleQNameAnnotation);
  75         }
  76         return result;
  77     }
  78
  79     public static Annotation createRequireIfcAnnotation(
  80             ServiceInterfaceEntry sie) {
  81         String reqIfc = sie.getFullyQualifiedName() + ".class";
  82         return new Annotation(RequireInterface.class.getCanonicalName(),
  83                 Lists.newArrayList(new Parameter("value", reqIfc)));
  84     }
  85
  86     private static final String quote = "\"";
  87
  88     private static String q(String nullableDescription) {
  89         return nullableDescription == null ? null : quote + nullableDescription
  90                 + quote;
  91     }
  92
  93     public static class Parameter {
  94         private final String key, value;
  95
  96         public Parameter(String key, String value) {
  97             this.key = key;
  98             this.value = value;
  99         }
 100
 101         public String getKey() {
 102             return key;
 103         }
 104
 105         public String getValue() {
 106             return value;
 107         }
 108     }
 109
 110 }