opendaylight/sal/yang-prototype/yang/yang-model-util/src/main/java/org/opendaylight/controller/model/util/EnumerationType.java

   1 /*\r
   2   * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3   *\r
   4   * This program and the accompanying materials are made available under the\r
   5   * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6   * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7   */\r
   8 package org.opendaylight.controller.model.util;\r
   9 \r
  10 import java.util.Collections;\r
  11 import java.util.List;\r
  12 \r
  13 import org.opendaylight.controller.model.api.type.EnumTypeDefinition;\r
  14 import org.opendaylight.controller.yang.common.QName;\r
  15 import org.opendaylight.controller.yang.model.api.SchemaPath;\r
  16 import org.opendaylight.controller.yang.model.api.Status;\r
  17 import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;\r
  18 \r
  19 public class EnumerationType implements EnumTypeDefinition {\r
  20 \r
  21     private final QName name = BaseTypes.constructQName("enumeration");\r
  22     private final SchemaPath path = BaseTypes.schemaPath(name);\r
  23     private final String description = "The enumeration built-in type represents values from a set of assigned names.";\r
  24     private final String reference = "https://tools.ietf.org/html/rfc6020#section-9.6";\r
  25 \r
  26     private final List<EnumPair> defaultEnum;\r
  27     private final List<EnumPair> enums;\r
  28     private String units = "";\r
  29 \r
  30     public EnumerationType(final List<EnumPair> enums) {\r
  31         super();\r
  32         this.enums = enums;\r
  33 \r
  34         defaultEnum = Collections.emptyList();\r
  35     }\r
  36 \r
  37     public EnumerationType(final List<EnumPair> defaultEnum,\r
  38             final List<EnumPair> enums, final String units) {\r
  39         super();\r
  40         this.defaultEnum = defaultEnum;\r
  41         this.enums = enums;\r
  42         this.units = units;\r
  43     }\r
  44 \r
  45     /*\r
  46      * (non-Javadoc)\r
  47      * \r
  48      * @see org.opendaylight.controller.yang.model.api.TypeDefinition#getBaseType()\r
  49      */\r
  50     @Override\r
  51     public EnumTypeDefinition getBaseType() {\r
  52         return this;\r
  53     }\r
  54 \r
  55     /*\r
  56      * (non-Javadoc)\r
  57      * \r
  58      * @see org.opendaylight.controller.yang.model.api.TypeDefinition#getUnits()\r
  59      */\r
  60     @Override\r
  61     public String getUnits() {\r
  62         return units;\r
  63     }\r
  64 \r
  65     /*\r
  66      * (non-Javadoc)\r
  67      * \r
  68      * @see org.opendaylight.controller.yang.model.api.TypeDefinition#getDefaultValue()\r
  69      */\r
  70     @Override\r
  71     public Object getDefaultValue() {\r
  72         return defaultEnum;\r
  73     }\r
  74 \r
  75     /*\r
  76      * (non-Javadoc)\r
  77      * \r
  78      * @see org.opendaylight.controller.yang.model.api.SchemaNode#getQName()\r
  79      */\r
  80     @Override\r
  81     public QName getQName() {\r
  82         return name;\r
  83     }\r
  84 \r
  85     /*\r
  86      * (non-Javadoc)\r
  87      * \r
  88      * @see org.opendaylight.controller.yang.model.api.SchemaNode#getPath()\r
  89      */\r
  90     @Override\r
  91     public SchemaPath getPath() {\r
  92         return path;\r
  93     }\r
  94 \r
  95     /*\r
  96      * (non-Javadoc)\r
  97      * \r
  98      * @see org.opendaylight.controller.yang.model.api.SchemaNode#getDescription()\r
  99      */\r
 100     @Override\r
 101     public String getDescription() {\r
 102         return description;\r
 103     }\r
 104 \r
 105     /*\r
 106      * (non-Javadoc)\r
 107      * \r
 108      * @see org.opendaylight.controller.yang.model.api.SchemaNode#getReference()\r
 109      */\r
 110     @Override\r
 111     public String getReference() {\r
 112         return reference;\r
 113     }\r
 114 \r
 115     /*\r
 116      * (non-Javadoc)\r
 117      * \r
 118      * @see org.opendaylight.controller.yang.model.api.SchemaNode#getStatus()\r
 119      */\r
 120     @Override\r
 121     public Status getStatus() {\r
 122         return Status.CURRENT;\r
 123     }\r
 124 \r
 125     /*\r
 126      * (non-Javadoc)\r
 127      * \r
 128      * @see org.opendaylight.controller.yang.model.base.type.api.EnumTypeDefinition#getValues()\r
 129      */\r
 130     @Override\r
 131     public List<EnumPair> getValues() {\r
 132         return enums;\r
 133     }\r
 134 \r
 135     @Override\r
 136     public List<UnknownSchemaNode> getUnknownSchemaNodes() {\r
 137         return Collections.emptyList();\r
 138     }\r
 139 \r
 140     @Override\r
 141     public int hashCode() {\r
 142         final int prime = 31;\r
 143         int result = 1;\r
 144         result = prime * result\r
 145                 + ((defaultEnum == null) ? 0 : defaultEnum.hashCode());\r
 146         result = prime * result\r
 147                 + ((description == null) ? 0 : description.hashCode());\r
 148         result = prime * result + ((enums == null) ? 0 : enums.hashCode());\r
 149         result = prime * result + ((name == null) ? 0 : name.hashCode());\r
 150         result = prime * result + ((path == null) ? 0 : path.hashCode());\r
 151         result = prime * result\r
 152                 + ((reference == null) ? 0 : reference.hashCode());\r
 153         result = prime * result + ((units == null) ? 0 : units.hashCode());\r
 154         return result;\r
 155     }\r
 156 \r
 157     @Override\r
 158     public boolean equals(Object obj) {\r
 159         if (this == obj) {\r
 160             return true;\r
 161         }\r
 162         if (obj == null) {\r
 163             return false;\r
 164         }\r
 165         if (getClass() != obj.getClass()) {\r
 166             return false;\r
 167         }\r
 168         EnumerationType other = (EnumerationType) obj;\r
 169         if (defaultEnum == null) {\r
 170             if (other.defaultEnum != null) {\r
 171                 return false;\r
 172             }\r
 173         } else if (!defaultEnum.equals(other.defaultEnum)) {\r
 174             return false;\r
 175         }\r
 176         if (description == null) {\r
 177             if (other.description != null) {\r
 178                 return false;\r
 179             }\r
 180         } else if (!description.equals(other.description)) {\r
 181             return false;\r
 182         }\r
 183         if (enums == null) {\r
 184             if (other.enums != null) {\r
 185                 return false;\r
 186             }\r
 187         } else if (!enums.equals(other.enums)) {\r
 188             return false;\r
 189         }\r
 190         if (name == null) {\r
 191             if (other.name != null) {\r
 192                 return false;\r
 193             }\r
 194         } else if (!name.equals(other.name)) {\r
 195             return false;\r
 196         }\r
 197         if (path == null) {\r
 198             if (other.path != null) {\r
 199                 return false;\r
 200             }\r
 201         } else if (!path.equals(other.path)) {\r
 202             return false;\r
 203         }\r
 204         if (reference == null) {\r
 205             if (other.reference != null) {\r
 206                 return false;\r
 207             }\r
 208         } else if (!reference.equals(other.reference)) {\r
 209             return false;\r
 210         }\r
 211         if (units == null) {\r
 212             if (other.units != null) {\r
 213                 return false;\r
 214             }\r
 215         } else if (!units.equals(other.units)) {\r
 216             return false;\r
 217         }\r
 218         return true;\r
 219     }\r
 220 \r
 221     @Override\r
 222     public String toString() {\r
 223         StringBuilder builder = new StringBuilder();\r
 224         builder.append("EnumerationType [name=");\r
 225         builder.append(name);\r
 226         builder.append(", path=");\r
 227         builder.append(path);\r
 228         builder.append(", description=");\r
 229         builder.append(description);\r
 230         builder.append(", reference=");\r
 231         builder.append(reference);\r
 232         builder.append(", defaultEnum=");\r
 233         builder.append(defaultEnum);\r
 234         builder.append(", enums=");\r
 235         builder.append(enums);\r
 236         builder.append(", units=");\r
 237         builder.append(units);\r
 238         builder.append("]");\r
 239         return builder.toString();\r
 240     }\r
 241 }\r