opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/package-info.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 \r
   9 /**\r
  10  * Definition of structures and DOM Like API of processed YANG schema\r
  11  * \r
  12  * <h3>YANG Statement mapping</h3>\r
  13  * \r
  14  * <dl>\r
  15  * <dt>anyxml\r
  16  *   <dd>{@link org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode}\r
  17  * \r
  18  * <dt>argument\r
  19  *   <dd>{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition#getArgumentName()}\r
  20  * \r
  21  * \r
  22  * <dt>augment\r
  23  *   <dd>{@link org.opendaylight.controller.yang.model.api.AugmentationSchema}\r
  24  * \r
  25  * <dt>base\r
  26  *   <dd>{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition#getIdentity()}\r
  27  * \r
  28  * <dt>belongs-to\r
  29  *   <dd>\r
  30  * \r
  31  * <dt>bit\r
  32  *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit}\r
  33  *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition#getBits()}\r
  34  * \r
  35  * <dt>case\r
  36  *   <dd>{@link org.opendaylight.controller.yang.model.api.ChoiceCaseNode}\r
  37  * \r
  38  * <dt>choice\r
  39  *   <dd>{@link org.opendaylight.controller.yang.model.api.ChoiceNode}\r
  40  * \r
  41  * <dt>config\r
  42  *   <dd>{@link org.opendaylight.controller.yang.model.api.DataSchemaNode#isConfiguration()}\r
  43  * \r
  44  * <dt>contact\r
  45  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getContact()}\r
  46  * \r
  47  * <dt>container\r
  48  *   <dd>{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode}\r
  49  * \r
  50  * <dt>default\r
  51  *   <dd>\r
  52  * \r
  53  * <dt>description\r
  54  *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getDescription()}\r
  55  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getDescription()}\r
  56  * \r
  57  * <dt>enum\r
  58  *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair}\r
  59  *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition#getValues()}\r
  60  * \r
  61  * <dt>error-app-tag\r
  62  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorAppTag()}\r
  63  * \r
  64  * <dt>error-message\r
  65  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorMessage()}\r
  66  * \r
  67  * <dt>extension\r
  68  *   <dd>{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition}\r
  69  * \r
  70  * <dt>deviation\r
  71  *   <dd>{@link org.opendaylight.controller.yang.model.api.Deviation}\r
  72  * \r
  73  * <dt>deviate\r
  74  *   <dd>\r
  75  * \r
  76  * <dt>feature\r
  77  *   <dd>{@link org.opendaylight.controller.yang.model.api.FeatureDefinition}\r
  78  * \r
  79  * <dt>fraction-digits\r
  80  *   <dd>{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition#getFractionDigits()}\r
  81  * \r
  82  * <dt>grouping\r
  83  *   <dd>{@link org.opendaylight.controller.yang.model.api.GroupingDefinition}\r
  84  * \r
  85  * <dt>identity\r
  86  *   <dd>\r
  87  * \r
  88  * <dt>if-feature\r
  89  *   <dd>\r
  90  * \r
  91  * <dt>import\r
  92  *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport}\r
  93  * \r
  94  * <dt>include\r
  95  *   <dd>\r
  96  * \r
  97  * <dt>input\r
  98  *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getInput()}\r
  99  * \r
 100  * <dt>key\r
 101  *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#getKeyDefinition()}\r
 102  * \r
 103  * <dt>leaf\r
 104  *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode}\r
 105  * \r
 106  * <dt>leaf-list\r
 107  *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode}\r
 108  * \r
 109  * <dt>length\r
 110  *   <dd>{@link org.opendaylight.controller.model.api.type.LengthConstraint}\r
 111  *   <dd>{@link org.opendaylight.controller.model.api.type.StringTypeDefinition#getLengthStatements()}\r
 112  * \r
 113  * <dt>list\r
 114  *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode}\r
 115  * \r
 116  * <dt>mandatory\r
 117  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#isMandatory()}\r
 118  * \r
 119  * <dt>max-elements\r
 120  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMinElements()}\r
 121  * \r
 122  * <dt>min-elements\r
 123  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMaxElements()}\r
 124  * \r
 125  * <dt>module\r
 126  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module}\r
 127  * \r
 128  * <dt>must\r
 129  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMustConstraints()}\r
 130  *   <dd>{@link org.opendaylight.controller.yang.model.api.MustDefinition}\r
 131  * \r
 132  * <dt>namespace\r
 133  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getNamespace()}\r
 134  * \r
 135  * <dt>notification\r
 136  *   <dd>{@link org.opendaylight.controller.yang.model.api.NotificationDefinition}\r
 137  * \r
 138  * <dt>ordered-by\r
 139  *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#isUserOrdered()}\r
 140  *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#isUserOrdered()}\r
 141  * \r
 142  * <dt>organization\r
 143  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getOrganization()}\r
 144  * \r
 145  * <dt>output\r
 146  *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getOutput()}\r
 147  * \r
 148  * <dt>path\r
 149  *   <dd>{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition#getPathStatement()}\r
 150  * \r
 151  * <dt>pattern\r
 152  *   <dd>{@link org.opendaylight.controller.yang.model.base.type.api.PatternConstraint}\r
 153  *   <dd>{@link org.opendaylight.controller.model.api.type.StringTypeDefinition}\r
 154  * \r
 155  * <dt>position\r
 156  *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit#getPosition()}\r
 157  * \r
 158  * <dt>prefix\r
 159  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getPrefix()}\r
 160  *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport#getPrefix()}\r
 161  * \r
 162  * <dt>presence\r
 163  *   <dd>{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode#isPresenceContainer()}\r
 164  * \r
 165  * <dt>range\r
 166  *   <dd>{@link org.opendaylight.controller.model.api.type.RangeConstraint}\r
 167  *   <dd>{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition#getRangeStatements()}\r
 168  *   <dd>{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition#getRangeStatements()}\r
 169  * \r
 170  * <dt>reference\r
 171  *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getReference()}\r
 172  * \r
 173  * <dt>refine\r
 174  *   <dd>\r
 175  * \r
 176  * <dt>require-instance\r
 177  *   <dd>{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition#requireInstance()}\r
 178  * \r
 179  * <dt>revision\r
 180  *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getRevision()}\r
 181  * \r
 182  * <dt>revision-date\r
 183  *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport#getRevision()}\r
 184  * \r
 185  * <dt>rpc\r
 186  *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition}\r
 187  * \r
 188  * <dt>status\r
 189  *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getStatus()}\r
 190  * \r
 191  * <dt>submodule\r
 192  *   <dd>\r
 193  * \r
 194  * <dt>type\r
 195  *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition}\r
 196  *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode#getType()}\r
 197  *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#getType()}\r
 198  * \r
 199  * <dt>typedef\r
 200  *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition}\r
 201  * \r
 202  * <dt>unique\r
 203  *   <dd>\r
 204  * \r
 205  * <dt>units\r
 206  *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition#getUnits()}\r
 207  * \r
 208  * <dt>uses\r
 209  *   <dd>{@link org.opendaylight.controller.yang.model.api.UsesNode}\r
 210  *   <dd>{@link org.opendaylight.controller.yang.model.api.DataNodeContainere#getUses()}\r
 211  * \r
 212  * <dt>value\r
 213  *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair#getValue()}\r
 214  * \r
 215  * <dt>when\r
 216  *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getWhenCondition()}\r
 217  * \r
 218  * <dt>yang-version\r
 219  * \r
 220  * <dt>yin-element\r
 221  *   <dd>\r
 222  * \r
 223  * \r
 224  * \r
 225  * \r
 226  * <dt>add\r
 227  *   <dd>\r
 228  * \r
 229  * <dt>current\r
 230  *   <dd>\r
 231  * \r
 232  * <dt>delete\r
 233  *   <dd>\r
 234  * \r
 235  * <dt>deprecated\r
 236  *   <dd>\r
 237  * \r
 238  * <dt>false\r
 239  *   <dd>\r
 240  * \r
 241  * <dt>max\r
 242  *   <dd>\r
 243  * \r
 244  * <dt>min\r
 245  *   <dd>\r
 246  * \r
 247  * <dt>not-supported\r
 248  *   <dd>\r
 249  * \r
 250  * <dt>obsolete\r
 251  *   <dd>\r
 252  * \r
 253  * <dt>replace\r
 254  *   <dd>\r
 255  * \r
 256  * <dt>system\r
 257  *   <dd>\r
 258  * \r
 259  * <dt>true\r
 260  *   <dd>\r
 261  * \r
 262  * <dt>unbounded\r
 263  *   <dd>\r
 264  * \r
 265  * <dt>user\r
 266  *   <dd>\r
 267  * </dl>\r
 268  * \r
 269  * \r
 270  * <h3>YANG Base Type Mapping</h3>\r
 271  * \r
 272  * \r
 273  * <dl>\r
 274  * <dt>Integer built-in type\r
 275  *   <dd>{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition}\r
 276  * \r
 277  * <dt>Unsigned integer built-in type\r
 278  *   <dd>{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition}\r
 279  * \r
 280  * <dt>Decimal64 built-ib type\r
 281  *   <dd>{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition}\r
 282  * \r
 283  * <dt>Boolean built-in type\r
 284  *   <dd>{@link org.opendaylight.controller.model.api.type.BooleanTypeDefinition}\r
 285  *   \r
 286  * <dt>Enumeration built-in type\r
 287  *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition}\r
 288  *   \r
 289  * <dt>Bits Built-In Type\r
 290  *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition}\r
 291  * \r
 292  * <dt>The binary Built-In Type\r
 293  *   <dd>{@link org.opendaylight.controller.model.api.type.BinaryTypeDefinition}\r
 294  *   \r
 295  * <dt>The leafref Built-In Type\r
 296  *   <dd>{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition}\r
 297  * \r
 298  * <dt>The identityref Built-In Type\r
 299  *   <dd>{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition}\r
 300  *   \r
 301  * <dt>The empty Built-In Type\r
 302  *   <dd>{@link org.opendaylight.controller.model.api.type.EmptyTypeDefinition}\r
 303  *   \r
 304  * <dt>The union Built-In Type\r
 305  *   <dd>{@link org.opendaylight.controller.model.api.type.UnionTypeDefinition}\r
 306  * <dt>The instance-identifier Built-In Type\r
 307  *   <dd>{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition}\r
 308  * \r
 309  * </dl>\r
 310  */\r
 311 package org.opendaylight.controller.yang.model.api;\r
 312 \r