Code Review / controller.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Initial opendaylight infrastructure commit!!
[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / yang / model / api / package-info.java
diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/package-info.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/package-info.java
new file mode 100644 (file)
index 0000000..77bcd95
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/package-info.java
@@ -0,0 +1,312 @@
+/*\r
+  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
+  *\r
+  * This program and the accompanying materials are made available under the\r
+  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+  */\r
+\r
+/**\r
+ * Definition of structures and DOM Like API of processed YANG schema\r
+ * \r
+ * <h3>YANG Statement mapping</h3>\r
+ * \r
+ * <dl>\r
+ * <dt>anyxml\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode}\r
+ * \r
+ * <dt>argument\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition#getArgumentName()}\r
+ * \r
+ * \r
+ * <dt>augment\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.AugmentationSchema}\r
+ * \r
+ * <dt>base\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition#getIdentity()}\r
+ * \r
+ * <dt>belongs-to\r
+ *   <dd>\r
+ * \r
+ * <dt>bit\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition#getBits()}\r
+ * \r
+ * <dt>case\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ChoiceCaseNode}\r
+ * \r
+ * <dt>choice\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ChoiceNode}\r
+ * \r
+ * <dt>config\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.DataSchemaNode#isConfiguration()}\r
+ * \r
+ * <dt>contact\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getContact()}\r
+ * \r
+ * <dt>container\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode}\r
+ * \r
+ * <dt>default\r
+ *   <dd>\r
+ * \r
+ * <dt>description\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getDescription()}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getDescription()}\r
+ * \r
+ * <dt>enum\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition#getValues()}\r
+ * \r
+ * <dt>error-app-tag\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorAppTag()}\r
+ * \r
+ * <dt>error-message\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorMessage()}\r
+ * \r
+ * <dt>extension\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition}\r
+ * \r
+ * <dt>deviation\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Deviation}\r
+ * \r
+ * <dt>deviate\r
+ *   <dd>\r
+ * \r
+ * <dt>feature\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.FeatureDefinition}\r
+ * \r
+ * <dt>fraction-digits\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition#getFractionDigits()}\r
+ * \r
+ * <dt>grouping\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.GroupingDefinition}\r
+ * \r
+ * <dt>identity\r
+ *   <dd>\r
+ * \r
+ * <dt>if-feature\r
+ *   <dd>\r
+ * \r
+ * <dt>import\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport}\r
+ * \r
+ * <dt>include\r
+ *   <dd>\r
+ * \r
+ * <dt>input\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getInput()}\r
+ * \r
+ * <dt>key\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#getKeyDefinition()}\r
+ * \r
+ * <dt>leaf\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode}\r
+ * \r
+ * <dt>leaf-list\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode}\r
+ * \r
+ * <dt>length\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.LengthConstraint}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.StringTypeDefinition#getLengthStatements()}\r
+ * \r
+ * <dt>list\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode}\r
+ * \r
+ * <dt>mandatory\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#isMandatory()}\r
+ * \r
+ * <dt>max-elements\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMinElements()}\r
+ * \r
+ * <dt>min-elements\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMaxElements()}\r
+ * \r
+ * <dt>module\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module}\r
+ * \r
+ * <dt>must\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMustConstraints()}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.MustDefinition}\r
+ * \r
+ * <dt>namespace\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getNamespace()}\r
+ * \r
+ * <dt>notification\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.NotificationDefinition}\r
+ * \r
+ * <dt>ordered-by\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#isUserOrdered()}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#isUserOrdered()}\r
+ * \r
+ * <dt>organization\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getOrganization()}\r
+ * \r
+ * <dt>output\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getOutput()}\r
+ * \r
+ * <dt>path\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition#getPathStatement()}\r
+ * \r
+ * <dt>pattern\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.base.type.api.PatternConstraint}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.StringTypeDefinition}\r
+ * \r
+ * <dt>position\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit#getPosition()}\r
+ * \r
+ * <dt>prefix\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getPrefix()}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport#getPrefix()}\r
+ * \r
+ * <dt>presence\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode#isPresenceContainer()}\r
+ * \r
+ * <dt>range\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.RangeConstraint}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition#getRangeStatements()}\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition#getRangeStatements()}\r
+ * \r
+ * <dt>reference\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getReference()}\r
+ * \r
+ * <dt>refine\r
+ *   <dd>\r
+ * \r
+ * <dt>require-instance\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition#requireInstance()}\r
+ * \r
+ * <dt>revision\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.Module#getRevision()}\r
+ * \r
+ * <dt>revision-date\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ModuleImport#getRevision()}\r
+ * \r
+ * <dt>rpc\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.RpcDefinition}\r
+ * \r
+ * <dt>status\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.SchemaNode#getStatus()}\r
+ * \r
+ * <dt>submodule\r
+ *   <dd>\r
+ * \r
+ * <dt>type\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode#getType()}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#getType()}\r
+ * \r
+ * <dt>typedef\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition}\r
+ * \r
+ * <dt>unique\r
+ *   <dd>\r
+ * \r
+ * <dt>units\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.TypeDefinition#getUnits()}\r
+ * \r
+ * <dt>uses\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.UsesNode}\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.DataNodeContainere#getUses()}\r
+ * \r
+ * <dt>value\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair#getValue()}\r
+ * \r
+ * <dt>when\r
+ *   <dd>{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getWhenCondition()}\r
+ * \r
+ * <dt>yang-version\r
+ * \r
+ * <dt>yin-element\r
+ *   <dd>\r
+ * \r
+ * \r
+ * \r
+ * \r
+ * <dt>add\r
+ *   <dd>\r
+ * \r
+ * <dt>current\r
+ *   <dd>\r
+ * \r
+ * <dt>delete\r
+ *   <dd>\r
+ * \r
+ * <dt>deprecated\r
+ *   <dd>\r
+ * \r
+ * <dt>false\r
+ *   <dd>\r
+ * \r
+ * <dt>max\r
+ *   <dd>\r
+ * \r
+ * <dt>min\r
+ *   <dd>\r
+ * \r
+ * <dt>not-supported\r
+ *   <dd>\r
+ * \r
+ * <dt>obsolete\r
+ *   <dd>\r
+ * \r
+ * <dt>replace\r
+ *   <dd>\r
+ * \r
+ * <dt>system\r
+ *   <dd>\r
+ * \r
+ * <dt>true\r
+ *   <dd>\r
+ * \r
+ * <dt>unbounded\r
+ *   <dd>\r
+ * \r
+ * <dt>user\r
+ *   <dd>\r
+ * </dl>\r
+ * \r
+ * \r
+ * <h3>YANG Base Type Mapping</h3>\r
+ * \r
+ * \r
+ * <dl>\r
+ * <dt>Integer built-in type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition}\r
+ * \r
+ * <dt>Unsigned integer built-in type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition}\r
+ * \r
+ * <dt>Decimal64 built-ib type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition}\r
+ * \r
+ * <dt>Boolean built-in type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BooleanTypeDefinition}\r
+ *   \r
+ * <dt>Enumeration built-in type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition}\r
+ *   \r
+ * <dt>Bits Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition}\r
+ * \r
+ * <dt>The binary Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.BinaryTypeDefinition}\r
+ *   \r
+ * <dt>The leafref Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition}\r
+ * \r
+ * <dt>The identityref Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition}\r
+ *   \r
+ * <dt>The empty Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.EmptyTypeDefinition}\r
+ *   \r
+ * <dt>The union Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.UnionTypeDefinition}\r
+ * <dt>The instance-identifier Built-In Type\r
+ *   <dd>{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition}\r
+ * \r
+ * </dl>\r
+ */\r
+package org.opendaylight.controller.yang.model.api;\r
+\r
OpenDaylight controller