model/yang-model-ri/src/main/java/org/opendaylight/yangtools/yang/model/ri/type/EnumPairBuilder.java

   1 /*
   2  * Copyright (c) 2016 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.ri.type;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.concepts.Mutable;
  17 import org.opendaylight.yangtools.yang.model.api.Status;
  18 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair;
  20
  21 /**
  22  * Utility builder for {@link EnumPair} instances.
  23  */
  24 @Beta
  25 public final class EnumPairBuilder implements Mutable {
  26     private final String name;
  27     private final Integer value;
  28
  29     private ImmutableList<UnknownSchemaNode> unknownSchemaNodes = ImmutableList.of();
  30     private Status status = Status.CURRENT;
  31     private String description;
  32     private String reference;
  33
  34     private EnumPairBuilder(final String name, final Integer value) {
  35         this.name = requireNonNull(name);
  36         this.value = requireNonNull(value);
  37     }
  38
  39     public static @NonNull EnumPairBuilder create(final String name, final Integer value) {
  40         return new EnumPairBuilder(name, value);
  41     }
  42
  43     public @NonNull EnumPairBuilder setDescription(final String description) {
  44         this.description = description;
  45         return this;
  46     }
  47
  48     public @NonNull EnumPairBuilder setReference(final String reference) {
  49         this.reference = reference;
  50         return this;
  51     }
  52
  53     public @NonNull EnumPairBuilder setStatus(final Status status) {
  54         this.status = requireNonNull(status);
  55         return this;
  56     }
  57
  58     public @NonNull EnumPairBuilder setUnknownSchemaNodes(
  59             final Collection<? extends UnknownSchemaNode> unknownSchemaNodes) {
  60         this.unknownSchemaNodes = ImmutableList.copyOf(unknownSchemaNodes);
  61         return this;
  62     }
  63
  64     public @NonNull EnumPairBuilder setUnknownSchemaNodes(final UnknownSchemaNode... unknownSchemaNodes) {
  65         this.unknownSchemaNodes = ImmutableList.copyOf(unknownSchemaNodes);
  66         return this;
  67     }
  68
  69     /**
  70      * Return an {@link EnumPair} representation of this builder's current state.
  71      *
  72      * @return An EnumPair
  73      */
  74     public @NonNull EnumPair build() {
  75         return new EnumPairImpl(name, value, description, reference, status, unknownSchemaNodes);
  76     }
  77 }