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