X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fyang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fyang%2Fmodel%2Fapi%2Fpackage-info.java;h=efe909e9d8054971464d3022c53ef3cd60bd066b;hb=154b5dde1af41aff2ae0cc6e08400153162a4a3c;hp=77bcd9532f36232d899a38a7f1beeb43ca33d1cc;hpb=42210c03b0a4c54706320ba9f55794c0abd4d201;p=controller.git 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 index 77bcd9532f..efe909e9d8 100644 --- 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 @@ -1,312 +1,312 @@ -/* - * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - */ - -/** - * Definition of structures and DOM Like API of processed YANG schema - * - *

YANG Statement mapping

- * - *
- *
anyxml - *
{@link org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode} - * - *
argument - *
{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition#getArgumentName()} - * - * - *
augment - *
{@link org.opendaylight.controller.yang.model.api.AugmentationSchema} - * - *
base - *
{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition#getIdentity()} - * - *
belongs-to - *
- * - *
bit - *
{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit} - *
{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition#getBits()} - * - *
case - *
{@link org.opendaylight.controller.yang.model.api.ChoiceCaseNode} - * - *
choice - *
{@link org.opendaylight.controller.yang.model.api.ChoiceNode} - * - *
config - *
{@link org.opendaylight.controller.yang.model.api.DataSchemaNode#isConfiguration()} - * - *
contact - *
{@link org.opendaylight.controller.yang.model.api.Module#getContact()} - * - *
container - *
{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode} - * - *
default - *
- * - *
description - *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getDescription()} - *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getDescription()} - * - *
enum - *
{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair} - *
{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition#getValues()} - * - *
error-app-tag - *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorAppTag()} - * - *
error-message - *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorMessage()} - * - *
extension - *
{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition} - * - *
deviation - *
{@link org.opendaylight.controller.yang.model.api.Deviation} - * - *
deviate - *
- * - *
feature - *
{@link org.opendaylight.controller.yang.model.api.FeatureDefinition} - * - *
fraction-digits - *
{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition#getFractionDigits()} - * - *
grouping - *
{@link org.opendaylight.controller.yang.model.api.GroupingDefinition} - * - *
identity - *
- * - *
if-feature - *
- * - *
import - *
{@link org.opendaylight.controller.yang.model.api.ModuleImport} - * - *
include - *
- * - *
input - *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getInput()} - * - *
key - *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#getKeyDefinition()} - * - *
leaf - *
{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode} - * - *
leaf-list - *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode} - * - *
length - *
{@link org.opendaylight.controller.model.api.type.LengthConstraint} - *
{@link org.opendaylight.controller.model.api.type.StringTypeDefinition#getLengthStatements()} - * - *
list - *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode} - * - *
mandatory - *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#isMandatory()} - * - *
max-elements - *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMinElements()} - * - *
min-elements - *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMaxElements()} - * - *
module - *
{@link org.opendaylight.controller.yang.model.api.Module} - * - *
must - *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMustConstraints()} - *
{@link org.opendaylight.controller.yang.model.api.MustDefinition} - * - *
namespace - *
{@link org.opendaylight.controller.yang.model.api.Module#getNamespace()} - * - *
notification - *
{@link org.opendaylight.controller.yang.model.api.NotificationDefinition} - * - *
ordered-by - *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#isUserOrdered()} - *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#isUserOrdered()} - * - *
organization - *
{@link org.opendaylight.controller.yang.model.api.Module#getOrganization()} - * - *
output - *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getOutput()} - * - *
path - *
{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition#getPathStatement()} - * - *
pattern - *
{@link org.opendaylight.controller.yang.model.base.type.api.PatternConstraint} - *
{@link org.opendaylight.controller.model.api.type.StringTypeDefinition} - * - *
position - *
{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition.Bit#getPosition()} - * - *
prefix - *
{@link org.opendaylight.controller.yang.model.api.Module#getPrefix()} - *
{@link org.opendaylight.controller.yang.model.api.ModuleImport#getPrefix()} - * - *
presence - *
{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode#isPresenceContainer()} - * - *
range - *
{@link org.opendaylight.controller.model.api.type.RangeConstraint} - *
{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition#getRangeStatements()} - *
{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition#getRangeStatements()} - * - *
reference - *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getReference()} - * - *
refine - *
- * - *
require-instance - *
{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition#requireInstance()} - * - *
revision - *
{@link org.opendaylight.controller.yang.model.api.Module#getRevision()} - * - *
revision-date - *
{@link org.opendaylight.controller.yang.model.api.ModuleImport#getRevision()} - * - *
rpc - *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition} - * - *
status - *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getStatus()} - * - *
submodule - *
- * - *
type - *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition} - *
{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode#getType()} - *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#getType()} - * - *
typedef - *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition} - * - *
unique - *
- * - *
units - *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition#getUnits()} - * - *
uses - *
{@link org.opendaylight.controller.yang.model.api.UsesNode} - *
{@link org.opendaylight.controller.yang.model.api.DataNodeContainere#getUses()} - * - *
value - *
{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition.EnumPair#getValue()} - * - *
when - *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getWhenCondition()} - * - *
yang-version - * - *
yin-element - *
- * - * - * - * - *
add - *
- * - *
current - *
- * - *
delete - *
- * - *
deprecated - *
- * - *
false - *
- * - *
max - *
- * - *
min - *
- * - *
not-supported - *
- * - *
obsolete - *
- * - *
replace - *
- * - *
system - *
- * - *
true - *
- * - *
unbounded - *
- * - *
user - *
- *
- * - * - *

YANG Base Type Mapping

- * - * - *
- *
Integer built-in type - *
{@link org.opendaylight.controller.model.api.type.IntegerTypeDefinition} - * - *
Unsigned integer built-in type - *
{@link org.opendaylight.controller.model.api.type.UnsignedIntegerTypeDefinition} - * - *
Decimal64 built-ib type - *
{@link org.opendaylight.controller.model.api.type.DecimalTypeDefinition} - * - *
Boolean built-in type - *
{@link org.opendaylight.controller.model.api.type.BooleanTypeDefinition} - * - *
Enumeration built-in type - *
{@link org.opendaylight.controller.model.api.type.EnumTypeDefinition} - * - *
Bits Built-In Type - *
{@link org.opendaylight.controller.model.api.type.BitsTypeDefinition} - * - *
The binary Built-In Type - *
{@link org.opendaylight.controller.model.api.type.BinaryTypeDefinition} - * - *
The leafref Built-In Type - *
{@link org.opendaylight.controller.model.api.type.LeafrefTypeDefinition} - * - *
The identityref Built-In Type - *
{@link org.opendaylight.controller.model.api.type.IdentityrefTypeDefinition} - * - *
The empty Built-In Type - *
{@link org.opendaylight.controller.model.api.type.EmptyTypeDefinition} - * - *
The union Built-In Type - *
{@link org.opendaylight.controller.model.api.type.UnionTypeDefinition} - *
The instance-identifier Built-In Type - *
{@link org.opendaylight.controller.model.api.type.InstanceIdentifierTypeDefinition} - * - *
- */ -package org.opendaylight.controller.yang.model.api; - +/* + * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ + +/** + * Definition of structures and DOM Like API of processed YANG schema + * + *

YANG Statement mapping

+ * + *
+ *
anyxml + *
{@link org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode} + * + *
argument + *
{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition#getArgumentName()} + * + * + *
augment + *
{@link org.opendaylight.controller.yang.model.api.AugmentationSchema} + * + *
base + *
{@link org.opendaylight.controller.yang.model.api.type.IdentityrefTypeDefinition#getIdentity()} + * + *
belongs-to + *
+ * + *
bit + *
{@link org.opendaylight.controller.yang.model.api.type.BitsTypeDefinition.Bit} + *
{@link org.opendaylight.controller.yang.model.api.type.BitsTypeDefinition#getBits()} + * + *
case + *
{@link org.opendaylight.controller.yang.model.api.ChoiceCaseNode} + * + *
choice + *
{@link org.opendaylight.controller.yang.model.api.ChoiceNode} + * + *
config + *
{@link org.opendaylight.controller.yang.model.api.DataSchemaNode#isConfiguration()} + * + *
contact + *
{@link org.opendaylight.controller.yang.model.api.Module#getContact()} + * + *
container + *
{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode} + * + *
default + *
+ * + *
description + *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getDescription()} + *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getDescription()} + * + *
enum + *
{@link org.opendaylight.controller.yang.model.api.type.EnumTypeDefinition.EnumPair} + *
{@link org.opendaylight.controller.yang.model.api.type.EnumTypeDefinition#getValues()} + * + *
error-app-tag + *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorAppTag()} + * + *
error-message + *
{@link org.opendaylight.controller.yang.model.api.ConstraintMetaDefinition#getErrorMessage()} + * + *
extension + *
{@link org.opendaylight.controller.yang.model.api.ExtensionDefinition} + * + *
deviation + *
{@link org.opendaylight.controller.yang.model.api.Deviation} + * + *
deviate + *
+ * + *
feature + *
{@link org.opendaylight.controller.yang.model.api.FeatureDefinition} + * + *
fraction-digits + *
{@link org.opendaylight.controller.yang.model.api.type.DecimalTypeDefinition#getFractionDigits()} + * + *
grouping + *
{@link org.opendaylight.controller.yang.model.api.GroupingDefinition} + * + *
identity + *
+ * + *
if-feature + *
+ * + *
import + *
{@link org.opendaylight.controller.yang.model.api.ModuleImport} + * + *
include + *
+ * + *
input + *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getInput()} + * + *
key + *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#getKeyDefinition()} + * + *
leaf + *
{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode} + * + *
leaf-list + *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode} + * + *
length + *
{@link org.opendaylight.controller.yang.model.api.type.LengthConstraint} + *
{@link org.opendaylight.controller.yang.model.api.type.StringTypeDefinition#getLengthStatements()} + * + *
list + *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode} + * + *
mandatory + *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#isMandatory()} + * + *
max-elements + *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMinElements()} + * + *
min-elements + *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMaxElements()} + * + *
module + *
{@link org.opendaylight.controller.yang.model.api.Module} + * + *
must + *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getMustConstraints()} + *
{@link org.opendaylight.controller.yang.model.api.MustDefinition} + * + *
namespace + *
{@link org.opendaylight.controller.yang.model.api.Module#getNamespace()} + * + *
notification + *
{@link org.opendaylight.controller.yang.model.api.NotificationDefinition} + * + *
ordered-by + *
{@link org.opendaylight.controller.yang.model.api.ListSchemaNode#isUserOrdered()} + *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#isUserOrdered()} + * + *
organization + *
{@link org.opendaylight.controller.yang.model.api.Module#getOrganization()} + * + *
output + *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition#getOutput()} + * + *
path + *
{@link org.opendaylight.controller.yang.model.api.type.LeafrefTypeDefinition#getPathStatement()} + * + *
pattern + *
{@link org.opendaylight.controller.yang.model.base.type.api.PatternConstraint} + *
{@link org.opendaylight.controller.yang.model.api.type.StringTypeDefinition} + * + *
position + *
{@link org.opendaylight.controller.yang.model.api.type.BitsTypeDefinition.Bit#getPosition()} + * + *
prefix + *
{@link org.opendaylight.controller.yang.model.api.Module#getPrefix()} + *
{@link org.opendaylight.controller.yang.model.api.ModuleImport#getPrefix()} + * + *
presence + *
{@link org.opendaylight.controller.yang.model.api.ContainerSchemaNode#isPresenceContainer()} + * + *
range + *
{@link org.opendaylight.controller.yang.model.api.type.RangeConstraint} + *
{@link org.opendaylight.controller.yang.model.api.type.IntegerTypeDefinition#getRangeStatements()} + *
{@link org.opendaylight.controller.yang.model.api.type.UnsignedIntegerTypeDefinition#getRangeStatements()} + * + *
reference + *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getReference()} + * + *
refine + *
+ * + *
require-instance + *
{@link org.opendaylight.controller.yang.model.api.type.InstanceIdentifierTypeDefinition#requireInstance()} + * + *
revision + *
{@link org.opendaylight.controller.yang.model.api.Module#getRevision()} + * + *
revision-date + *
{@link org.opendaylight.controller.yang.model.api.ModuleImport#getRevision()} + * + *
rpc + *
{@link org.opendaylight.controller.yang.model.api.RpcDefinition} + * + *
status + *
{@link org.opendaylight.controller.yang.model.api.SchemaNode#getStatus()} + * + *
submodule + *
+ * + *
type + *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition} + *
{@link org.opendaylight.controller.yang.model.api.LeafSchemaNode#getType()} + *
{@link org.opendaylight.controller.yang.model.api.LeafListSchemaNode#getType()} + * + *
typedef + *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition} + * + *
unique + *
+ * + *
units + *
{@link org.opendaylight.controller.yang.model.api.TypeDefinition#getUnits()} + * + *
uses + *
{@link org.opendaylight.controller.yang.model.api.UsesNode} + *
{@link org.opendaylight.controller.yang.model.api.DataNodeContainere#getUses()} + * + *
value + *
{@link org.opendaylight.controller.yang.model.api.type.EnumTypeDefinition.EnumPair#getValue()} + * + *
when + *
{@link org.opendaylight.controller.yang.model.api.ConstraintDefinition#getWhenCondition()} + * + *
yang-version + * + *
yin-element + *
+ * + * + * + * + *
add + *
+ * + *
current + *
+ * + *
delete + *
+ * + *
deprecated + *
+ * + *
false + *
+ * + *
max + *
+ * + *
min + *
+ * + *
not-supported + *
+ * + *
obsolete + *
+ * + *
replace + *
+ * + *
system + *
+ * + *
true + *
+ * + *
unbounded + *
+ * + *
user + *
+ *
+ * + * + *

YANG Base Type Mapping

+ * + * + *
+ *
Integer built-in type + *
{@link org.opendaylight.controller.yang.model.api.type.IntegerTypeDefinition} + * + *
Unsigned integer built-in type + *
{@link org.opendaylight.controller.yang.model.api.type.UnsignedIntegerTypeDefinition} + * + *
Decimal64 built-ib type + *
{@link org.opendaylight.controller.yang.model.api.type.DecimalTypeDefinition} + * + *
Boolean built-in type + *
{@link org.opendaylight.controller.yang.model.api.type.BooleanTypeDefinition} + * + *
Enumeration built-in type + *
{@link org.opendaylight.controller.yang.model.api.type.EnumTypeDefinition} + * + *
Bits Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.BitsTypeDefinition} + * + *
The binary Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.BinaryTypeDefinition} + * + *
The leafref Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.LeafrefTypeDefinition} + * + *
The identityref Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.IdentityrefTypeDefinition} + * + *
The empty Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.EmptyTypeDefinition} + * + *
The union Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.UnionTypeDefinition} + *
The instance-identifier Built-In Type + *
{@link org.opendaylight.controller.yang.model.api.type.InstanceIdentifierTypeDefinition} + * + *
+ */ +package org.opendaylight.controller.yang.model.api; +