yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/TypeStatement.java

   1 /*
   2  * Copyright (c) 2015 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 package org.opendaylight.yangtools.yang.model.api.stmt;
   9
  10 import java.util.Collection;
  11 import java.util.Optional;
  12 import javax.annotation.Nonnull;
  13 import javax.annotation.Nullable;
  14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  15
  16 @Rfc6020AbnfRule("type-stmt")
  17 public interface TypeStatement extends DeclaredStatement<String> {
  18     default @Nonnull String getName() {
  19         return argument();
  20     }
  21
  22     @Rfc6020AbnfRule("numerical-restrictions")
  23     interface NumericalRestrictions extends TypeStatement {
  24
  25         default @Nonnull RangeStatement getRange() {
  26             return findFirstDeclaredSubstatement(RangeStatement.class).get();
  27         }
  28     }
  29
  30     @Rfc6020AbnfRule("decimal64-specification")
  31     interface Decimal64Specification extends TypeStatement {
  32         default @Nonnull FractionDigitsStatement getFractionDigits() {
  33             return findFirstDeclaredSubstatement(FractionDigitsStatement.class).get();
  34         }
  35
  36         default @Nullable RangeStatement getRange() {
  37             final Optional<RangeStatement> opt = findFirstDeclaredSubstatement(RangeStatement.class);
  38             return opt.isPresent() ? opt.get() : null;
  39         }
  40     }
  41
  42     @Rfc6020AbnfRule("string-restrictions")
  43     interface StringRestrictions extends TypeStatement {
  44         default @Nullable LengthStatement getLength() {
  45             final Optional<LengthStatement> opt = findFirstDeclaredSubstatement(LengthStatement.class);
  46             return opt.isPresent() ? opt.get() : null;
  47         }
  48
  49         default @Nonnull Collection<? extends PatternStatement> getPatterns() {
  50             return declaredSubstatements(PatternStatement.class);
  51         }
  52     }
  53
  54     @Rfc6020AbnfRule("enum-specification")
  55     interface EnumSpecification extends TypeStatement {
  56
  57         default @Nonnull Collection<? extends EnumStatement> getEnums() {
  58             return declaredSubstatements(EnumStatement.class);
  59         }
  60     }
  61
  62     @Rfc6020AbnfRule("leafref-specification")
  63     interface LeafrefSpecification extends TypeStatement {
  64         default @Nonnull PathStatement getPath() {
  65             return findFirstDeclaredSubstatement(PathStatement.class).get();
  66         }
  67
  68         /**
  69          * Return require-instance statement child, if present. For RFC6020 semantics, this method always returns
  70          * null.
  71          *
  72          * @return require-instance statement, if present.
  73          */
  74         default @Nullable RequireInstanceStatement getRequireInstance() {
  75             final Optional<RequireInstanceStatement> opt =
  76                     findFirstDeclaredSubstatement(RequireInstanceStatement.class);
  77             return opt.isPresent() ? opt.get() : null;
  78         }
  79     }
  80
  81     @Rfc6020AbnfRule("instanceidentifier-specification")
  82     interface InstanceIdentifierSpecification extends TypeStatement {
  83         /**
  84          * Return require-instance statement child, if present. For RFC6020 semantics, this method always returns
  85          * null.
  86          *
  87          * @return require-instance statement, if present.
  88          */
  89         default @Nullable RequireInstanceStatement getRequireInstance() {
  90             final Optional<RequireInstanceStatement> opt =
  91                     findFirstDeclaredSubstatement(RequireInstanceStatement.class);
  92             return opt.isPresent() ? opt.get() : null;
  93         }
  94     }
  95
  96     @Rfc6020AbnfRule("identityref-specification")
  97     interface IdentityRefSpecification extends TypeStatement {
  98         /**
  99          * Returns the base statements.
 100          *
 101          * @return collection of base statements (in YANG 1.1 models) or a collection containing just one base
 102          *         statement (in YANG 1.0 models)
 103          */
 104         default @Nonnull Collection<? extends BaseStatement> getBases() {
 105             return declaredSubstatements(BaseStatement.class);
 106         }
 107     }
 108
 109     @Rfc6020AbnfRule("bits-specification")
 110     interface BitsSpecification extends TypeStatement {
 111         default @Nonnull Collection<? extends BitStatement> getBits() {
 112             return declaredSubstatements(BitStatement.class);
 113         }
 114     }
 115
 116     @Rfc6020AbnfRule("union-specification")
 117     interface UnionSpecification extends TypeStatement {
 118         default @Nonnull Collection<? extends TypeStatement> getTypes() {
 119             return declaredSubstatements(TypeStatement.class);
 120         }
 121     }
 122
 123     @Rfc6020AbnfRule("binary-specification")
 124     interface BinarySpecification extends TypeStatement {
 125         default @Nonnull Collection<? extends LengthStatement> getLength() {
 126             return declaredSubstatements(LengthStatement.class);
 127         }
 128     }
 129 }