yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/type/DerivedTypes.java

   1 /*
   2  * Copyright (c) 2015 Pantheon Technologies s.r.o. 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 package org.opendaylight.yangtools.yang.model.util.type;
   9
  10 import com.google.common.annotations.Beta;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  13 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  14 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
  15 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  16 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  17 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
  27
  28 /**
  29  * YANG defines 'derived type' as a type created through a 'typedef' statement. These types are exposed in the
  30  * hierarchical namespace and can be looked up.
  31  *
  32  * A derived type can redefine the default value, description, status and reference of a particular type definition.
  33  * It can only refine the units attribute, as that attribute is tied to the semantics of the value. The default value,
  34  * and units attributes are inherited from the super (base or restricted) type, others are left undefined if not
  35  * explicitly set. Status defaults to current.
  36  */
  37 /*
  38  * FIXME: Create ConcreteTypes
  39  *        Leaf and leaf-list statements provide for a similar mechanism by which a particular type is changed, most
  40  *        notably with the ability to redefine the default type. The resulting types could conceivably be called
  41  *        'concrete types', as they cannot be referenced by another leaf or type definition. This aspect needs to be
  42  *        split out into a 'ConcreteTypes' class.
  43  *
  44  *        Builders should use the fly-weight pattern to minimize footprint for cases when leaves do not override any
  45  *        aspect of the base type.
  46  */
  47 @Beta
  48 public final class DerivedTypes {
  49     private DerivedTypes() {
  50         throw new UnsupportedOperationException();
  51     }
  52
  53     public static DerivedTypeBuilder<?> derivedTypeBuilder(@Nonnull final TypeDefinition<?> baseType,
  54             @Nonnull final SchemaPath path) {
  55         if (baseType instanceof BinaryTypeDefinition) {
  56             return derivedBinaryBuilder((BinaryTypeDefinition) baseType, path);
  57         } else if (baseType instanceof BitsTypeDefinition) {
  58             return derivedBitsBuilder((BitsTypeDefinition) baseType, path);
  59         } else if (baseType instanceof BooleanTypeDefinition) {
  60             return derivedBooleanBuilder((BooleanTypeDefinition) baseType, path);
  61         } else if (baseType instanceof DecimalTypeDefinition) {
  62             return derivedDecimalBuilder((DecimalTypeDefinition) baseType, path);
  63         } else if (baseType instanceof EmptyTypeDefinition) {
  64             return derivedEmptyBuilder((EmptyTypeDefinition) baseType, path);
  65         } else if (baseType instanceof EnumTypeDefinition) {
  66             return derivedEnumerationBuilder((EnumTypeDefinition) baseType, path);
  67         } else if (baseType instanceof IdentityrefTypeDefinition) {
  68             return derivedIdentityrefBuilder((IdentityrefTypeDefinition) baseType, path);
  69         } else if (baseType instanceof InstanceIdentifierTypeDefinition) {
  70             return derivedInstanceIdentifierBuilder((InstanceIdentifierTypeDefinition) baseType, path);
  71         } else if (baseType instanceof IntegerTypeDefinition) {
  72             return derivedIntegerBuilder((IntegerTypeDefinition) baseType, path);
  73         } else if (baseType instanceof LeafrefTypeDefinition) {
  74             return derivedLeafrefBuilder((LeafrefTypeDefinition) baseType, path);
  75         } else if (baseType instanceof StringTypeDefinition) {
  76             return derivedStringBuilder((StringTypeDefinition) baseType, path);
  77         } else if (baseType instanceof UnionTypeDefinition) {
  78             return derivedUnionBuilder((UnionTypeDefinition) baseType, path);
  79         } else if (baseType instanceof UnsignedIntegerTypeDefinition) {
  80             return derivedUnsignedBuilder((UnsignedIntegerTypeDefinition) baseType, path);
  81         } else {
  82             throw new IllegalArgumentException("Unhandled type definition class " + baseType.getClass());
  83         }
  84     }
  85
  86     public static DerivedTypeBuilder<BinaryTypeDefinition> derivedBinaryBuilder(@Nonnull final BinaryTypeDefinition baseType, @Nonnull final SchemaPath path) {
  87         return new DerivedTypeBuilder<BinaryTypeDefinition>(baseType, path) {
  88             @Override
  89             public BinaryTypeDefinition build() {
  90                 return new DerivedBinaryType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
  91                     getStatus(), getUnits(), getUnknownSchemaNodes());
  92             }
  93         };
  94     }
  95
  96     public static DerivedTypeBuilder<BitsTypeDefinition> derivedBitsBuilder(final BitsTypeDefinition baseType, final SchemaPath path) {
  97         return new DerivedTypeBuilder<BitsTypeDefinition>(baseType, path) {
  98             @Override
  99             public BitsTypeDefinition build() {
 100                 return new DerivedBitsType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 101                     getStatus(), getUnits(), getUnknownSchemaNodes());
 102             }
 103         };
 104     }
 105
 106     public static DerivedTypeBuilder<BooleanTypeDefinition> derivedBooleanBuilder(@Nonnull final BooleanTypeDefinition baseType, @Nonnull final SchemaPath path) {
 107         return new DerivedTypeBuilder<BooleanTypeDefinition>(baseType, path) {
 108             @Override
 109             public BooleanTypeDefinition build() {
 110                 return new DerivedBooleanType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 111                     getStatus(), getUnits(), getUnknownSchemaNodes());
 112             }
 113         };
 114     }
 115
 116     public static DerivedTypeBuilder<DecimalTypeDefinition> derivedDecimalBuilder(final DecimalTypeDefinition baseType, final SchemaPath path) {
 117         return new DerivedTypeBuilder<DecimalTypeDefinition>(baseType, path) {
 118             @Override
 119             public DecimalTypeDefinition build() {
 120                 return new DerivedDecimalType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 121                     getStatus(), getUnits(), getUnknownSchemaNodes());
 122             }
 123         };
 124     }
 125
 126     public static DerivedTypeBuilder<EmptyTypeDefinition> derivedEmptyBuilder(final EmptyTypeDefinition baseType, final SchemaPath path) {
 127         return new DerivedTypeBuilder<EmptyTypeDefinition>(baseType, path) {
 128             @Override
 129             public EmptyTypeDefinition build() {
 130                 return new DerivedEmptyType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 131                     getStatus(), getUnits(), getUnknownSchemaNodes());
 132             }
 133         };
 134     }
 135
 136     public static DerivedTypeBuilder<EnumTypeDefinition> derivedEnumerationBuilder(final EnumTypeDefinition baseType, final SchemaPath path) {
 137         return new DerivedTypeBuilder<EnumTypeDefinition>(baseType, path) {
 138             @Override
 139             public EnumTypeDefinition build() {
 140                 return new DerivedEnumerationType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 141                     getStatus(), getUnits(), getUnknownSchemaNodes());
 142             }
 143         };
 144     }
 145
 146     public static DerivedTypeBuilder<IdentityrefTypeDefinition> derivedIdentityrefBuilder(final IdentityrefTypeDefinition baseType, final SchemaPath path) {
 147         return new DerivedTypeBuilder<IdentityrefTypeDefinition>(baseType, path) {
 148             @Override
 149             public IdentityrefTypeDefinition build() {
 150                 return new DerivedIdentityrefType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 151                     getStatus(), getUnits(), getUnknownSchemaNodes());
 152             }
 153         };
 154     }
 155
 156     public static DerivedTypeBuilder<InstanceIdentifierTypeDefinition> derivedInstanceIdentifierBuilder(final InstanceIdentifierTypeDefinition baseType, final SchemaPath path) {
 157         return new DerivedTypeBuilder<InstanceIdentifierTypeDefinition>(baseType, path) {
 158             @Override
 159             public InstanceIdentifierTypeDefinition build() {
 160                 return new DerivedInstanceIdentifierType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 161                     getStatus(), getUnits(), getUnknownSchemaNodes(), baseType.requireInstance());
 162             }
 163         };
 164     }
 165
 166     public static DerivedTypeBuilder<IntegerTypeDefinition> derivedIntegerBuilder(final IntegerTypeDefinition baseType, final SchemaPath path) {
 167         return new DerivedTypeBuilder<IntegerTypeDefinition>(baseType, path) {
 168             @Override
 169             public IntegerTypeDefinition build() {
 170                 return new DerivedIntegerType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 171                     getStatus(), getUnits(), getUnknownSchemaNodes());
 172             }
 173         };
 174     }
 175
 176     public static DerivedTypeBuilder<LeafrefTypeDefinition> derivedLeafrefBuilder(final LeafrefTypeDefinition baseType, final SchemaPath path) {
 177         return new DerivedTypeBuilder<LeafrefTypeDefinition>(baseType, path) {
 178             @Override
 179             public LeafrefTypeDefinition build() {
 180                 return new DerivedLeafrefType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 181                     getStatus(), getUnits(), getUnknownSchemaNodes());
 182             }
 183         };
 184     }
 185
 186     public static DerivedTypeBuilder<StringTypeDefinition> derivedStringBuilder(final StringTypeDefinition baseType, final SchemaPath path) {
 187         return new DerivedTypeBuilder<StringTypeDefinition>(baseType, path) {
 188             @Override
 189             public StringTypeDefinition build() {
 190                 return new DerivedStringType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 191                     getStatus(), getUnits(), getUnknownSchemaNodes());
 192             }
 193         };
 194     }
 195
 196     public static DerivedTypeBuilder<UnionTypeDefinition> derivedUnionBuilder(final UnionTypeDefinition baseType, final SchemaPath path) {
 197         return new DerivedTypeBuilder<UnionTypeDefinition>(baseType, path) {
 198             @Override
 199             public DerivedUnionType build() {
 200                 return new DerivedUnionType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 201                     getStatus(), getUnits(), getUnknownSchemaNodes());
 202             }
 203         };
 204     }
 205
 206     public static DerivedTypeBuilder<UnsignedIntegerTypeDefinition> derivedUnsignedBuilder(final UnsignedIntegerTypeDefinition baseType, final SchemaPath path) {
 207         return new DerivedTypeBuilder<UnsignedIntegerTypeDefinition>(baseType, path) {
 208             @Override
 209             public UnsignedIntegerTypeDefinition build() {
 210                 return new DerivedUnsignedType(getBaseType(), getPath(), getDefaultValue(), getDescription(), getReference(),
 211                     getStatus(), getUnits(), getUnknownSchemaNodes());
 212             }
 213         };
 214     }
 215 }